{"items":[{"type":"link","label":"Membership","link":"/apis/membership/membership-v1","routeSlug":"/apis/membership/membership-v1","content":{"contentType":"overview","meta":{"name":"Membership"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"membership-v1.json","url":"/_bundle/apis/membership/membership-v1.json?download"},{"kind":"download","label":"membership-v1.yaml","url":"/_bundle/apis/membership/membership-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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Membership (v1-2025-04-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look \nup the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.\n\nLike most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API."}],"sectionId":"/apis/membership/membership-v1"}],"sectionId":"/apis/membership/membership-v1"}]}]}},{"type":"group","label":"Add On Products","link":"/apis/membership/membership-v1/add-on-products","routeSlug":"/apis/membership/membership-v1/add-on-products","items":[{"label":"Gets all of the add on products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/listaddonproducts","routeSlug":"/apis/membership/membership-v1/add-on-products/listaddonproducts","metadata":{"seo":{"title":"Gets all of the add on products in the system.","description":"This method will scan all add on products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAddOnProducts","name":"Gets all of the add on products in the system.","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the add on products 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 add on products 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOnProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1addOnProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOnProducts/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOnProducts/{tenantId}","href":"add-on-products/listaddonproducts","openApiOperationId":"listAddOnProducts","summary":"Gets all of the add on products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_540"}},"schemaId":"schema_540","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_540","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_540"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/listaddonproducts"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}"},{"label":"Creates a new add on product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/createaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/createaddonproduct","metadata":{"seo":{"title":"Creates a new add on product record that does not already exist.","description":"This method will auto-generate an ID and create a new add on product. If an ID is specified for the add on product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAddOnProduct","name":"Creates a new add on product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new add on product 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 add on product. If an ID is specified for the add on product, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOnProducts~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/AddOnProduct"}},"schemaId":"components/schemas/AddOnProduct","pointer":"/paths/~1addOnProducts~1{tenantId}/post/requestBody","description":"The add on product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addOnProducts/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/addOnProducts/{tenantId}","href":"add-on-products/createaddonproduct","openApiOperationId":"createAddOnProduct","summary":"Creates a new add on product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddOnProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"schemaId":"components/schemas/AddOnProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The add on product 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The add on product 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_541"},{"code":"429","description":"Limit exceeded... unable to add add on product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/createaddonproduct"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}"},{"label":"Returns a list of records with the specified add_on_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/listproductsbyaddonid","routeSlug":"/apis/membership/membership-v1/add-on-products/listproductsbyaddonid","metadata":{"seo":{"title":"Returns a list of records with the specified add_on_id","description":"Returns a list of records with the specified add_on_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductsByAddOnId","name":"Returns a list of records with the specified add_on_id","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}~1addOn~1{add_on_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified add_on_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 add_on_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_539","description":"The tenant","required":true},{"name":"add_on_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The add_on_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1addOn~1{add_on_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1addOn~1{add_on_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOnProducts/{tenantId}/addOn/{add_on_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"add_on_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOnProducts/{tenantId}/addOn/{add_on_id}","href":"add-on-products/listproductsbyaddonid","openApiOperationId":"listProductsByAddOnId","summary":"Returns a list of records with the specified add_on_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListAddOnProductsResponse"}},"schemaId":"components/schemas/ListAddOnProductsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1addOn~1{add_on_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListAddOnProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListAddOnProductsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/listproductsbyaddonid"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}/addOn/{add_on_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/executebatchoperations","routeSlug":"/apis/membership/membership-v1/add-on-products/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/~1addOnProducts~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOnProducts~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/~1addOnProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addOnProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOnProducts/{tenantId}/batch","href":"add-on-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~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":"/add-on-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}/batch"},{"label":"Returns a add on product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/deleteaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/deleteaddonproduct","metadata":{"seo":{"title":"Returns a add on product from the system by its ID.","description":"This method will delete a add on product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAddOnProduct","name":"Returns a add on product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a add on product 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 add on product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on product to delete.","required":true}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/addOnProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOnProducts/{tenantId}/{id}","href":"add-on-products/deleteaddonproduct","openApiOperationId":"deleteAddOnProduct","summary":"Returns a add on product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The add on product 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_541"},{"code":"429","description":"Limit exceeded... unable to delete add on product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/deleteaddonproduct"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Returns a add on product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/getaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/getaddonproduct","metadata":{"seo":{"title":"Returns a add on product from the system by its ID.","description":"This method will look up a add on product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAddOnProduct","name":"Returns a add on product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a add on product 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 add on product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on product to return.","required":true}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOnProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOnProducts/{tenantId}/{id}","href":"add-on-products/getaddonproduct","openApiOperationId":"getAddOnProduct","summary":"Returns a add on product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"schemaId":"components/schemas/AddOnProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/getaddonproduct"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Partially updates a add on product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/patchaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/patchaddonproduct","metadata":{"seo":{"title":"Partially updates a add on product with the specified ID.","description":"This method will patch an existing add on product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAddOnProduct","name":"Partially updates a add on product with the specified ID.","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a add on product 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 add on product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on product to patch.","required":true}],"pointer":"/paths/~1addOnProducts~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1addOnProducts~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":"/addOnProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/addOnProducts/{tenantId}/{id}","href":"add-on-products/patchaddonproduct","openApiOperationId":"patchAddOnProduct","summary":"Partially updates a add on product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"schemaId":"components/schemas/AddOnProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The add on product 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/patchaddonproduct"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Updates a add on product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/updateaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/updateaddonproduct","metadata":{"seo":{"title":"Updates a add on product with the specified ID.","description":"This method will update an existing add on product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAddOnProduct","name":"Updates a add on product with the specified ID.","isWebhook":false,"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a add on product 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 add on product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on product to update.","required":true}],"pointer":"/paths/~1addOnProducts~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/AddOnProduct"}},"schemaId":"components/schemas/AddOnProduct","pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated add on product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/addOnProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/addOnProducts/{tenantId}/{id}","href":"add-on-products/updateaddonproduct","openApiOperationId":"updateAddOnProduct","summary":"Updates a add on product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddOnProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}},"schemaId":"components/schemas/AddOnProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The add on product 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The add on product 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-products/updateaddonproduct"}],"panels":[]}]},"httpPath":"/addOnProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Add On Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add On Products","showPageActions":true},{"nodeType":"markdoc","content":"Add On Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/addOnProducts/{tenantId}","summary":"Gets all of the add on products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-on-products/listaddonproducts","deprecated":false},{"title":"/addOnProducts/{tenantId}","summary":"Creates a new add on product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/add-on-products/createaddonproduct","deprecated":false},{"title":"/addOnProducts/{tenantId}/addOn/{add_on_id}","summary":"Returns a list of records with the specified add_on_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-on-products/listproductsbyaddonid","deprecated":false},{"title":"/addOnProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/add-on-products/executebatchoperations","deprecated":false},{"title":"/addOnProducts/{tenantId}/{id}","summary":"Returns a add on product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/add-on-products/deleteaddonproduct","deprecated":false},{"title":"/addOnProducts/{tenantId}/{id}","summary":"Returns a add on product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-on-products/getaddonproduct","deprecated":false},{"title":"/addOnProducts/{tenantId}/{id}","summary":"Partially updates a add on product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/add-on-products/patchaddonproduct","deprecated":false},{"title":"/addOnProducts/{tenantId}/{id}","summary":"Updates a add on product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/add-on-products/updateaddonproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Add On Types","link":"/apis/membership/membership-v1/add-on-types","routeSlug":"/apis/membership/membership-v1/add-on-types","items":[{"label":"Gets all of the add on types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/listaddontypes","routeSlug":"/apis/membership/membership-v1/add-on-types/listaddontypes","metadata":{"seo":{"title":"Gets all of the add on types in the system.","description":"This method will scan all add on types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAddOnTypes","name":"Gets all of the add on types in the system.","isWebhook":false,"pointer":"/paths/~1addOnTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOnTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1addOnTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOnTypes/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOnTypes/{tenantId}","href":"add-on-types/listaddontypes","openApiOperationId":"listAddOnTypes","summary":"Gets all of the add on types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}},"schemaId":"schema_543","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_543","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_543"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-types/listaddontypes"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}"},{"label":"Creates a new add on type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/createaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/createaddontype","metadata":{"seo":{"title":"Creates a new add on type record that does not already exist.","description":"This method will auto-generate an ID and create a new add on type. If an ID is specified for the add on type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAddOnType","name":"Creates a new add on type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1addOnTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new add on 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 add on type. If an ID is specified for the add on 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOnTypes~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/AddOnType"}},"schemaId":"components/schemas/AddOnType","pointer":"/paths/~1addOnTypes~1{tenantId}/post/requestBody","description":"The add on type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addOnTypes/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addOnTypes/{tenantId}","href":"add-on-types/createaddontype","openApiOperationId":"createAddOnType","summary":"Creates a new add on type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddOnType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"schemaId":"components/schemas/AddOnType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The add on 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to add add on 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-types/createaddontype"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/add-on-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/~1addOnTypes~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOnTypes~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/~1addOnTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addOnTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOnTypes/{tenantId}/batch","href":"add-on-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~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":"/add-on-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}/batch"},{"label":"Returns a add on type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/deleteaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/deleteaddontype","metadata":{"seo":{"title":"Returns a add on type from the system by its ID.","description":"This method will delete a add on type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAddOnType","name":"Returns a add on type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on type to delete.","required":true}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/addOnTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOnTypes/{tenantId}/{id}","href":"add-on-types/deleteaddontype","openApiOperationId":"deleteAddOnType","summary":"Returns a add on type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on 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_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to delete add on 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-types/deleteaddontype"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}/{id}"},{"label":"Returns a add on type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/getaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/getaddontype","metadata":{"seo":{"title":"Returns a add on type from the system by its ID.","description":"This method will look up a add on type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAddOnType","name":"Returns a add on type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on type to return.","required":true}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOnTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOnTypes/{tenantId}/{id}","href":"add-on-types/getaddontype","openApiOperationId":"getAddOnType","summary":"Returns a add on type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"schemaId":"components/schemas/AddOnType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-types/getaddontype"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}/{id}"},{"label":"Partially updates a add on type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/patchaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/patchaddontype","metadata":{"seo":{"title":"Partially updates a add on type with the specified ID.","description":"This method will patch an existing add on type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAddOnType","name":"Partially updates a add on type with the specified ID.","isWebhook":false,"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on type to patch.","required":true}],"pointer":"/paths/~1addOnTypes~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1addOnTypes~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":"/addOnTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addOnTypes/{tenantId}/{id}","href":"add-on-types/patchaddontype","openApiOperationId":"patchAddOnType","summary":"Partially updates a add on type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"schemaId":"components/schemas/AddOnType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on 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_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-types/patchaddontype"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}/{id}"},{"label":"Updates a add on type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/updateaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/updateaddontype","metadata":{"seo":{"title":"Updates a add on type with the specified ID.","description":"This method will update an existing add on type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAddOnType","name":"Updates a add on type with the specified ID.","isWebhook":false,"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on type to update.","required":true}],"pointer":"/paths/~1addOnTypes~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/AddOnType"}},"schemaId":"components/schemas/AddOnType","pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated add on type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/addOnTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addOnTypes/{tenantId}/{id}","href":"add-on-types/updateaddontype","openApiOperationId":"updateAddOnType","summary":"Updates a add on type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddOnType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}},"schemaId":"components/schemas/AddOnType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The add on 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on 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_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOnTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOnType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOnType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-on-types/updateaddontype"}],"panels":[]}]},"httpPath":"/addOnTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Add On Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add On Types","showPageActions":true},{"nodeType":"markdoc","content":"Add On Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/addOnTypes/{tenantId}","summary":"Gets all of the add on types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-on-types/listaddontypes","deprecated":false},{"title":"/addOnTypes/{tenantId}","summary":"Creates a new add on type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/add-on-types/createaddontype","deprecated":false},{"title":"/addOnTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/add-on-types/executebatchoperations","deprecated":false},{"title":"/addOnTypes/{tenantId}/{id}","summary":"Returns a add on type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/add-on-types/deleteaddontype","deprecated":false},{"title":"/addOnTypes/{tenantId}/{id}","summary":"Returns a add on type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-on-types/getaddontype","deprecated":false},{"title":"/addOnTypes/{tenantId}/{id}","summary":"Partially updates a add on type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/add-on-types/patchaddontype","deprecated":false},{"title":"/addOnTypes/{tenantId}/{id}","summary":"Updates a add on type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/add-on-types/updateaddontype","deprecated":false}]}]}]}]}},{"type":"group","label":"Add Ons","link":"/apis/membership/membership-v1/add-ons","routeSlug":"/apis/membership/membership-v1/add-ons","items":[{"label":"Gets all of the add ons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/listaddons","routeSlug":"/apis/membership/membership-v1/add-ons/listaddons","metadata":{"seo":{"title":"Gets all of the add ons in the system.","description":"This method will scan all add ons and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAddOns","name":"Gets all of the add ons in the system.","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the add ons 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 add ons 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOns~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1addOns~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOns/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOns/{tenantId}","href":"add-ons/listaddons","openApiOperationId":"listAddOns","summary":"Gets all of the add ons in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add onswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_544"}},"schemaId":"schema_544","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_544"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/listaddons"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}"},{"label":"Creates a new add on record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/createaddon","routeSlug":"/apis/membership/membership-v1/add-ons/createaddon","metadata":{"seo":{"title":"Creates a new add on record that does not already exist.","description":"This method will auto-generate an ID and create a new add on. If an ID is specified for the add on, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAddOn","name":"Creates a new add on record that does not already exist.","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new add on 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 add on. If an ID is specified for the add on, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOns~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/AddOn"}},"schemaId":"components/schemas/AddOn","pointer":"/paths/~1addOns~1{tenantId}/post/requestBody","description":"The add on that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addOns/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddOn"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addOns/{tenantId}","href":"add-ons/createaddon","openApiOperationId":"createAddOn","summary":"Creates a new add on record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddOn","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddOn"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}},"schemaId":"components/schemas/AddOn","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The add on 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to add add on based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOn","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/createaddon"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/executebatchoperations","routeSlug":"/apis/membership/membership-v1/add-ons/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/~1addOns~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1addOns~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/~1addOns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/addOns/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOns/{tenantId}/batch","href":"add-ons/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~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":"/add-ons/executebatchoperations"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}/batch"},{"label":"List all applicable add ons for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/listapplicableaddons","routeSlug":"/apis/membership/membership-v1/add-ons/listapplicableaddons","metadata":{"seo":{"title":"List all applicable add ons for a contact","description":"List all applicable add ons for a contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicableAddOns","name":"List all applicable add ons for a contact","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}~1portal~1getApplicable~1{customerType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all applicable add ons for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all applicable add ons for a 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_539","description":"The tenant","required":true},{"name":"customerType","in":"path","schemaId":"schema_539","description":"The membership package to describe chapters","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_539","description":"The membership package to describe chapters","required":true}],"pointer":"/paths/~1addOns~1{tenantId}~1portal~1getApplicable~1{customerType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOns/{tenantId}/portal/getApplicable/{customerType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOns/{tenantId}/portal/getApplicable/{customerType}/{contactOrOrganizationId}","href":"add-ons/listapplicableaddons","openApiOperationId":"listApplicableAddOns","summary":"List all applicable add ons for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_544"}},"schemaId":"schema_544","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}~1portal~1getApplicable~1{customerType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_544","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_544"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/listapplicableaddons"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}/portal/getApplicable/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a add on from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/deleteaddon","routeSlug":"/apis/membership/membership-v1/add-ons/deleteaddon","metadata":{"seo":{"title":"Returns a add on from the system by its ID.","description":"This method will delete a add on with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAddOn","name":"Returns a add on from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on to delete.","required":true}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/addOns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/addOns/{tenantId}/{id}","href":"add-ons/deleteaddon","openApiOperationId":"deleteAddOn","summary":"Returns a add on from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to delete add on based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/deleteaddon"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}/{id}"},{"label":"Returns a add on from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/getaddon","routeSlug":"/apis/membership/membership-v1/add-ons/getaddon","metadata":{"seo":{"title":"Returns a add on from the system by its ID.","description":"This method will look up a add on by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAddOn","name":"Returns a add on from the system by its ID.","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on to return.","required":true}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/addOns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/addOns/{tenantId}/{id}","href":"add-ons/getaddon","openApiOperationId":"getAddOn","summary":"Returns a add on from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 add on was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}},"schemaId":"components/schemas/AddOn","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOn","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/getaddon"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}/{id}"},{"label":"Partially updates a add on with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/patchaddon","routeSlug":"/apis/membership/membership-v1/add-ons/patchaddon","metadata":{"seo":{"title":"Partially updates a add on with the specified ID.","description":"This method will patch an existing add on with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAddOn","name":"Partially updates a add on with the specified ID.","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on to patch.","required":true}],"pointer":"/paths/~1addOns~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1addOns~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":"/addOns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addOns/{tenantId}/{id}","href":"add-ons/patchaddon","openApiOperationId":"patchAddOn","summary":"Partially updates a add on with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}},"schemaId":"components/schemas/AddOn","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOn","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/patchaddon"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}/{id}"},{"label":"Updates a add on with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/updateaddon","routeSlug":"/apis/membership/membership-v1/add-ons/updateaddon","metadata":{"seo":{"title":"Updates a add on with the specified ID.","description":"This method will update an existing add on with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAddOn","name":"Updates a add on with the specified ID.","isWebhook":false,"pointer":"/paths/~1addOns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a add on 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 add on 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the add on to update.","required":true}],"pointer":"/paths/~1addOns~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/AddOn"}},"schemaId":"components/schemas/AddOn","pointer":"/paths/~1addOns~1{tenantId}~1{id}/put/requestBody","description":"The updated add on that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/addOns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddOn"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/addOns/{tenantId}/{id}","href":"add-ons/updateaddon","openApiOperationId":"updateAddOn","summary":"Updates a add on with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AddOn","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddOn"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The add on was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}},"schemaId":"components/schemas/AddOn","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The add on 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The add on could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The add on 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve add on based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1addOns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AddOn","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AddOn"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/add-ons/updateaddon"}],"panels":[]}]},"httpPath":"/addOns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Add Ons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Ons","showPageActions":true},{"nodeType":"markdoc","content":"Add Ons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/addOns/{tenantId}","summary":"Gets all of the add ons in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-ons/listaddons","deprecated":false},{"title":"/addOns/{tenantId}","summary":"Creates a new add on record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/add-ons/createaddon","deprecated":false},{"title":"/addOns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/add-ons/executebatchoperations","deprecated":false},{"title":"/addOns/{tenantId}/portal/getApplicable/{customerType}/{contactOrOrganizationId}","summary":"List all applicable add ons for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-ons/listapplicableaddons","deprecated":false},{"title":"/addOns/{tenantId}/{id}","summary":"Returns a add on from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/add-ons/deleteaddon","deprecated":false},{"title":"/addOns/{tenantId}/{id}","summary":"Returns a add on from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/add-ons/getaddon","deprecated":false},{"title":"/addOns/{tenantId}/{id}","summary":"Partially updates a add on with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/add-ons/patchaddon","deprecated":false},{"title":"/addOns/{tenantId}/{id}","summary":"Updates a add on with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/add-ons/updateaddon","deprecated":false}]}]}]}]}},{"type":"group","label":"App Reference Types","link":"/apis/membership/membership-v1/app-reference-types","routeSlug":"/apis/membership/membership-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/membership/membership-v1/app-reference-types/listappreferencetypes","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_545"}},"schemaId":"schema_545","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_545","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_545"}}},{"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/membership/membership-v1/app-reference-types/createappreferencetype","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"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/membership/membership-v1/app-reference-types/deleteappreferencetype","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1appReferenceTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"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/membership/membership-v1/app-reference-types/getappreferencetype","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/app-reference-types/patchappreferencetype","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"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/membership/membership-v1/app-reference-types/updateappreferencetype","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"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":"Application Groups","link":"/apis/membership/membership-v1/application-groups","routeSlug":"/apis/membership/membership-v1/application-groups","items":[{"label":"Creates a new application group record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/createapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/createapplicationgroup","metadata":{"seo":{"title":"Creates a new application group record that does not already exist.","description":"This method will auto-generate an ID and create a new application group. If an ID is specified for the application group, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationGroup","name":"Creates a new application group record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applicationGroups~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application 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 application group. If an ID is specified for the application 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationGroups~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/ApplicationGroup"}},"schemaId":"components/schemas/ApplicationGroup","pointer":"/paths/~1applicationGroups~1{tenantId}/post/requestBody","description":"The application group that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationGroups/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationGroups/{tenantId}","href":"application-groups/createapplicationgroup","openApiOperationId":"createApplicationGroup","summary":"Creates a new application group record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"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 group was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"schemaId":"components/schemas/ApplicationGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The application 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to add application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/createapplicationgroup"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/executebatchoperations","routeSlug":"/apis/membership/membership-v1/application-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/~1applicationGroups~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationGroups~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/~1applicationGroups~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationGroups/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/applicationGroups/{tenantId}/batch","href":"application-groups/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~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-groups/executebatchoperations"}],"panels":[]}]},"httpPath":"/applicationGroups/{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/membership/membership-v1/application-groups/listgroupsbycontactid","routeSlug":"/apis/membership/membership-v1/application-groups/listgroupsbycontactid","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":"listGroupsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1applicationGroups~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_539","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_539","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/~1applicationGroups~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationGroups/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationGroups/{tenantId}/contact/{contact_id}","href":"application-groups/listgroupsbycontactid","openApiOperationId":"listGroupsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListApplicationGroupsResponse"}},"schemaId":"components/schemas/ListApplicationGroupsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListApplicationGroupsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListApplicationGroupsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/listgroupsbycontactid"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}/contact/{contact_id}"},{"label":"Searches for application groups using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/searchforapplicationgroups","routeSlug":"/apis/membership/membership-v1/application-groups/searchforapplicationgroups","metadata":{"seo":{"title":"Searches for application groups using predefined parameters","description":"Searches for application groups using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForApplicationGroups","name":"Searches for application groups using predefined parameters","isWebhook":false,"pointer":"/paths/~1applicationGroups~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for application groups 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 application groups 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_539","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1applicationGroups~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/ApplicationGroupSearchParameters"}},"schemaId":"components/schemas/ApplicationGroupSearchParameters","pointer":"/paths/~1applicationGroups~1{tenantId}~1search/post/requestBody","description":"The application group that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationGroups/{tenantId}/search","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationGroupSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationGroups/{tenantId}/search","href":"application-groups/searchforapplicationgroups","openApiOperationId":"searchForApplicationGroups","summary":"Searches for application groups using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationGroupSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationGroupSearchParameters"}},"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 group search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedApplicationGroupSearchResults"}},"schemaId":"components/schemas/PagedApplicationGroupSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The application 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to add application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedApplicationGroupSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedApplicationGroupSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/searchforapplicationgroups"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}/search"},{"label":"Returns a application group from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/deleteapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/deleteapplicationgroup","metadata":{"seo":{"title":"Returns a application group from the system by its ID.","description":"This method will delete a application group with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationGroup","name":"Returns a application group from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application group to delete.","required":true}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applicationGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/applicationGroups/{tenantId}/{id}","href":"application-groups/deleteapplicationgroup","openApiOperationId":"deleteApplicationGroup","summary":"Returns a application group from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 group was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to delete application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/deleteapplicationgroup"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}/{id}"},{"label":"Returns a application group from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/getapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/getapplicationgroup","metadata":{"seo":{"title":"Returns a application group from the system by its ID.","description":"This method will look up a application group by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationGroup","name":"Returns a application group from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application group to return.","required":true}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationGroups/{tenantId}/{id}","href":"application-groups/getapplicationgroup","openApiOperationId":"getApplicationGroup","summary":"Returns a application group from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 group was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"schemaId":"components/schemas/ApplicationGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/getapplicationgroup"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}/{id}"},{"label":"Partially updates a application group with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/patchapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/patchapplicationgroup","metadata":{"seo":{"title":"Partially updates a application group with the specified ID.","description":"This method will patch an existing application group with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplicationGroup","name":"Partially updates a application group with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application group to patch.","required":true}],"pointer":"/paths/~1applicationGroups~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1applicationGroups~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":"/applicationGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationGroups/{tenantId}/{id}","href":"application-groups/patchapplicationgroup","openApiOperationId":"patchApplicationGroup","summary":"Partially updates a application group with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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 group was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"schemaId":"components/schemas/ApplicationGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/patchapplicationgroup"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}/{id}"},{"label":"Updates a application group with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/updateapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/updateapplicationgroup","metadata":{"seo":{"title":"Updates a application group with the specified ID.","description":"This method will update an existing application group with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationGroup","name":"Updates a application group with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application group to update.","required":true}],"pointer":"/paths/~1applicationGroups~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/ApplicationGroup"}},"schemaId":"components/schemas/ApplicationGroup","pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/put/requestBody","description":"The updated application group that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applicationGroups/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationGroups/{tenantId}/{id}","href":"application-groups/updateapplicationgroup","openApiOperationId":"updateApplicationGroup","summary":"Updates a application group with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"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 group was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}},"schemaId":"components/schemas/ApplicationGroup","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The application 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationGroups~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationGroup"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-groups/updateapplicationgroup"}],"panels":[]}]},"httpPath":"/applicationGroups/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Application Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Groups","showPageActions":true},{"nodeType":"markdoc","content":"Application Groups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicationGroups/{tenantId}","summary":"Creates a new application group record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-groups/createapplicationgroup","deprecated":false},{"title":"/applicationGroups/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-groups/executebatchoperations","deprecated":false},{"title":"/applicationGroups/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-groups/listgroupsbycontactid","deprecated":false},{"title":"/applicationGroups/{tenantId}/search","summary":"Searches for application groups using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-groups/searchforapplicationgroups","deprecated":false},{"title":"/applicationGroups/{tenantId}/{id}","summary":"Returns a application group from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/application-groups/deleteapplicationgroup","deprecated":false},{"title":"/applicationGroups/{tenantId}/{id}","summary":"Returns a application group from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-groups/getapplicationgroup","deprecated":false},{"title":"/applicationGroups/{tenantId}/{id}","summary":"Partially updates a application group with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/application-groups/patchapplicationgroup","deprecated":false},{"title":"/applicationGroups/{tenantId}/{id}","summary":"Updates a application group with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/application-groups/updateapplicationgroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Application Processes","link":"/apis/membership/membership-v1/application-processes","routeSlug":"/apis/membership/membership-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/membership/membership-v1/application-processes/listapplicationprocesses","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_546"}},"schemaId":"schema_546","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}}},{"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/membership/membership-v1/application-processes/createapplicationprocess","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/application-processes/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/geteligibleprocesses","routeSlug":"/apis/membership/membership-v1/application-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleProcesses","name":"Gets all of the processes a contact/org is eligible to use","isWebhook":false,"pointer":"/paths/~1applicationProcesses~1{tenantId}~1eligible~1{customerType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the processes a contact/org 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_539","description":"The id of the tenant being accessed","required":true},{"name":"customerType","in":"path","schemaId":"schema_547","description":"The contact or organization type","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_539","description":"The contact or organization id","required":true}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1eligible~1{customerType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"customerType","in":"path","required":true,"schemaId":"schema_547"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_539"}],"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/{customerType}/{contactOrOrganizationId}","href":"application-processes/geteligibleprocesses","openApiOperationId":"getEligibleProcesses","summary":"Gets all of the processes a contact/org is eligible to use"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_546"}},"schemaId":"schema_546","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1eligible~1{customerType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_546","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_546"}}},{"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/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/deleteapplicationprocess","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/application-processes/getapplicationprocess","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/application-processes/patchapplicationprocess","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/application-processes/updateapplicationprocess","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/{customerType}/{contactOrOrganizationId}","summary":"Gets all of the processes a contact/org is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-processes/geteligibleprocesses","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 Status Reasons","link":"/apis/membership/membership-v1/application-status-reasons","routeSlug":"/apis/membership/membership-v1/application-status-reasons","items":[{"label":"Gets all of the application status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/listapplicationstatusreasons","routeSlug":"/apis/membership/membership-v1/application-status-reasons/listapplicationstatusreasons","metadata":{"seo":{"title":"Gets all of the application status reasons in the system.","description":"This method will scan all application status reasons and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationStatusReasons","name":"Gets all of the application status reasons in the system.","isWebhook":false,"pointer":"/paths/~1applicationStatusReasons~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the application 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 application 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationStatusReasons/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationStatusReasons/{tenantId}","href":"application-status-reasons/listapplicationstatusreasons","openApiOperationId":"listApplicationStatusReasons","summary":"Gets all of the application status reasons in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 status reasonswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_548"}},"schemaId":"schema_548","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_548","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_548"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-status-reasons/listapplicationstatusreasons"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Creates a new application status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/createapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/createapplicationstatusreason","metadata":{"seo":{"title":"Creates a new application status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new application status reason. If an ID is specified for the application status reason, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplicationStatusReason","name":"Creates a new application status reason record that does not already exist.","isWebhook":false,"pointer":"/paths/~1applicationStatusReasons~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new application 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 application status reason. If an ID is specified for the application 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationStatusReasons~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/ApplicationStatusReason"}},"schemaId":"components/schemas/ApplicationStatusReason","pointer":"/paths/~1applicationStatusReasons~1{tenantId}/post/requestBody","description":"The application status reason that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationStatusReasons/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationStatusReasons/{tenantId}","href":"application-status-reasons/createapplicationstatusreason","openApiOperationId":"createApplicationStatusReason","summary":"Creates a new application status reason record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationStatusReason","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"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 status reason was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"schemaId":"components/schemas/ApplicationStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The application 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to add application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-status-reasons/createapplicationstatusreason"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/executebatchoperations","routeSlug":"/apis/membership/membership-v1/application-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/~1applicationStatusReasons~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1applicationStatusReasons~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/~1applicationStatusReasons~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applicationStatusReasons/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/applicationStatusReasons/{tenantId}/batch","href":"application-status-reasons/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~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-status-reasons/executebatchoperations"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}/batch"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/deleteapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/deleteapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will delete a application status reason with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteApplicationStatusReason","name":"Returns a application status reason from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application status reason to delete.","required":true}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/applicationStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/applicationStatusReasons/{tenantId}/{id}","href":"application-status-reasons/deleteapplicationstatusreason","openApiOperationId":"deleteApplicationStatusReason","summary":"Returns a application status reason from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 status reason was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to delete application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-status-reasons/deleteapplicationstatusreason"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/getapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/getapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will look up a application status reason by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getApplicationStatusReason","name":"Returns a application status reason from the system by its ID.","isWebhook":false,"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application status reason to return.","required":true}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applicationStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/applicationStatusReasons/{tenantId}/{id}","href":"application-status-reasons/getapplicationstatusreason","openApiOperationId":"getApplicationStatusReason","summary":"Returns a application status reason from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 status reason was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"schemaId":"components/schemas/ApplicationStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-status-reasons/getapplicationstatusreason"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Partially updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/patchapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/patchapplicationstatusreason","metadata":{"seo":{"title":"Partially updates a application status reason with the specified ID.","description":"This method will patch an existing application status reason with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchApplicationStatusReason","name":"Partially updates a application status reason with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application status reason to patch.","required":true}],"pointer":"/paths/~1applicationStatusReasons~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1applicationStatusReasons~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":"/applicationStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationStatusReasons/{tenantId}/{id}","href":"application-status-reasons/patchapplicationstatusreason","openApiOperationId":"patchApplicationStatusReason","summary":"Partially updates a application status reason with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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 status reason was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"schemaId":"components/schemas/ApplicationStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-status-reasons/patchapplicationstatusreason"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/updateapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/updateapplicationstatusreason","metadata":{"seo":{"title":"Updates a application status reason with the specified ID.","description":"This method will update an existing application status reason with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateApplicationStatusReason","name":"Updates a application status reason with the specified ID.","isWebhook":false,"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a application 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 application 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the application status reason to update.","required":true}],"pointer":"/paths/~1applicationStatusReasons~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/ApplicationStatusReason"}},"schemaId":"components/schemas/ApplicationStatusReason","pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/put/requestBody","description":"The updated application status reason that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/applicationStatusReasons/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/applicationStatusReasons/{tenantId}/{id}","href":"application-status-reasons/updateapplicationstatusreason","openApiOperationId":"updateApplicationStatusReason","summary":"Updates a application status reason with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ApplicationStatusReason","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"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 status reason was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}},"schemaId":"components/schemas/ApplicationStatusReason","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The application 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The application 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_541"},{"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_541"},{"code":"409","description":"The application 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve application 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applicationStatusReasons~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplicationStatusReason","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplicationStatusReason"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/application-status-reasons/updateapplicationstatusreason"}],"panels":[]}]},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Application Status Reasons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Application Status Reasons","showPageActions":true},{"nodeType":"markdoc","content":"Application Status Reasons"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/applicationStatusReasons/{tenantId}","summary":"Gets all of the application status reasons in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-status-reasons/listapplicationstatusreasons","deprecated":false},{"title":"/applicationStatusReasons/{tenantId}","summary":"Creates a new application status reason record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-status-reasons/createapplicationstatusreason","deprecated":false},{"title":"/applicationStatusReasons/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/application-status-reasons/executebatchoperations","deprecated":false},{"title":"/applicationStatusReasons/{tenantId}/{id}","summary":"Returns a application status reason from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/application-status-reasons/deleteapplicationstatusreason","deprecated":false},{"title":"/applicationStatusReasons/{tenantId}/{id}","summary":"Returns a application status reason from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/application-status-reasons/getapplicationstatusreason","deprecated":false},{"title":"/applicationStatusReasons/{tenantId}/{id}","summary":"Partially updates a application status reason with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/application-status-reasons/patchapplicationstatusreason","deprecated":false},{"title":"/applicationStatusReasons/{tenantId}/{id}","summary":"Updates a application status reason with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/application-status-reasons/updateapplicationstatusreason","deprecated":false}]}]}]}]}},{"type":"group","label":"Applications","link":"/apis/membership/membership-v1/applications","routeSlug":"/apis/membership/membership-v1/applications","items":[{"label":"Creates a new application record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/createapplication","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/createapplication"}],"panels":[]}]},"httpPath":"/applications/{tenantId}"},{"label":"Returns a list of records with the specified application_group_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/listapplicationsbyapplicationgroupid","routeSlug":"/apis/membership/membership-v1/applications/listapplicationsbyapplicationgroupid","metadata":{"seo":{"title":"Returns a list of records with the specified application_group_id","description":"Returns a list of records with the specified application_group_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listApplicationsByApplicationGroupId","name":"Returns a list of records with the specified application_group_id","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1applicationGroup~1{application_group_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified application_group_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_group_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_539","description":"The tenant","required":true},{"name":"application_group_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The application_group_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1applications~1{tenantId}~1applicationGroup~1{application_group_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1applications~1{tenantId}~1applicationGroup~1{application_group_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/applications/{tenantId}/applicationGroup/{application_group_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"application_group_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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}/applicationGroup/{application_group_id}","href":"applications/listapplicationsbyapplicationgroupid","openApiOperationId":"listApplicationsByApplicationGroupId","summary":"Returns a list of records with the specified application_group_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applications~1{tenantId}~1applicationGroup~1{application_group_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/listapplicationsbyapplicationgroupid"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/applicationGroup/{application_group_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/applications/listapplicationsbycontactid","routeSlug":"/apis/membership/membership-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_539","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Generates an application for a contact or organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/generateapplications","routeSlug":"/apis/membership/membership-v1/applications/generateapplications","metadata":{"seo":{"title":"Generates an application for a contact or organization","description":"Generates an application for a contact or organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateApplications","name":"Generates an application for a contact or organization","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1generateApplication~1{processId}~1{ownerType}~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an application 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_539","description":"The id of the tenant being accessed","required":true},{"name":"processId","in":"path","schemaId":"schema_539","description":"The process id","required":true},{"name":"ownerType","in":"path","schemaId":"schema_547","description":"The contact or organization type","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The contact or organization type","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1generateApplication~1{processId}~1{ownerType}~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"processId","in":"path","required":true,"schemaId":"schema_539"},{"name":"ownerType","in":"path","required":true,"schemaId":"schema_547"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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}/{id}","href":"applications/generateapplications","openApiOperationId":"generateApplications","summary":"Generates an application for a contact or organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applications~1{tenantId}~1generateApplication~1{processId}~1{ownerType}~1{id}/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":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/generateapplications"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{id}"},{"label":"Generates an group order from a membership application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/generategrouporder","routeSlug":"/apis/membership/membership-v1/applications/generategrouporder","metadata":{"seo":{"title":"Generates an group order from a membership application","description":"This method will examine a membership application and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateGroupOrder","name":"Generates an group order from a membership application","isWebhook":false,"pointer":"/paths/~1applications~1{tenantId}~1generateGroupOrder~1{groupId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an group order from a membership 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 membership 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_539","description":"The id of the tenant being accessed","required":true},{"name":"groupId","in":"path","schemaId":"schema_539","description":"The ID of the group","required":true}],"pointer":"/paths/~1applications~1{tenantId}~1generateGroupOrder~1{groupId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/applications/{tenantId}/generateGroupOrder/{groupId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"groupId","in":"path","required":true,"schemaId":"schema_539"}],"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}/generateGroupOrder/{groupId}","href":"applications/generategrouporder","openApiOperationId":"generateGroupOrder","summary":"Generates an group order from a membership application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applications~1{tenantId}~1generateGroupOrder~1{groupId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/generategrouporder"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/generateGroupOrder/{groupId}"},{"label":"Generates an order from a membership application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/generateorder","routeSlug":"/apis/membership/membership-v1/applications/generateorder","metadata":{"seo":{"title":"Generates an order from a membership application","description":"This method will examine a membership application and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateOrder","name":"Generates an order from a membership 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 membership 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 membership 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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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 membership application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applications~1{tenantId}~1generateOrder/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"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/membership/membership-v1/applications/listapplicationsbyorganizationid","routeSlug":"/apis/membership/membership-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_539","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Searches for applications using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/searchforapplications","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_539"}],"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","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/applications/searchforapplications"}],"panels":[]}]},"httpPath":"/applications/{tenantId}/search"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/deleteapplication","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1applications~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"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/membership/membership-v1/applications/getapplication","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/applications/patchapplication","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"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/membership/membership-v1/applications/updateapplication","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"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":"Creates a new application record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/createapplication","deprecated":false},{"title":"/applications/{tenantId}/applicationGroup/{application_group_id}","summary":"Returns a list of records with the specified application_group_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/applications/listapplicationsbyapplicationgroupid","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}/generateApplication/{processId}/{ownerType}/{id}","summary":"Generates an application for a contact or organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/generateapplications","deprecated":false},{"title":"/applications/{tenantId}/generateGroupOrder/{groupId}","summary":"Generates an group order from a membership application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/generategrouporder","deprecated":false},{"title":"/applications/{tenantId}/generateOrder","summary":"Generates an order from a membership 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}/search","summary":"Searches for applications using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/applications/searchforapplications","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":"Ballots","link":"/apis/membership/membership-v1/ballots","routeSlug":"/apis/membership/membership-v1/ballots","items":[{"label":"Creates a new ballot record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/createballot","routeSlug":"/apis/membership/membership-v1/ballots/createballot","metadata":{"seo":{"title":"Creates a new ballot record that does not already exist.","description":"This method will auto-generate an ID and create a new ballot. If an ID is specified for the ballot, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBallot","name":"Creates a new ballot record that does not already exist.","isWebhook":false,"pointer":"/paths/~1ballots~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new ballot 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 ballot. If an ID is specified for the ballot, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1ballots~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/Ballot"}},"schemaId":"components/schemas/Ballot","pointer":"/paths/~1ballots~1{tenantId}/post/requestBody","description":"The ballot that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ballots/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Ballot"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/ballots/{tenantId}","href":"ballots/createballot","openApiOperationId":"createBallot","summary":"Creates a new ballot record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Ballot","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ballot"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ballot was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}},"schemaId":"components/schemas/Ballot","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The ballot 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The ballot 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_541"},{"code":"429","description":"Limit exceeded... unable to add ballot based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1ballots~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ballot","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ballots/createballot"}],"panels":[]}]},"httpPath":"/ballots/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/executebatchoperations","routeSlug":"/apis/membership/membership-v1/ballots/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/~1ballots~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1ballots~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/~1ballots~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/ballots/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/ballots/{tenantId}/batch","href":"ballots/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The ballot could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve ballot based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1ballots~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":"/ballots/executebatchoperations"}],"panels":[]}]},"httpPath":"/ballots/{tenantId}/batch"},{"label":"Returns a ballot from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/deleteballot","routeSlug":"/apis/membership/membership-v1/ballots/deleteballot","metadata":{"seo":{"title":"Returns a ballot from the system by its ID.","description":"This method will delete a ballot with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBallot","name":"Returns a ballot from the system by its ID.","isWebhook":false,"pointer":"/paths/~1ballots~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a ballot 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 ballot 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the ballot to delete.","required":true}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/ballots/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/ballots/{tenantId}/{id}","href":"ballots/deleteballot","openApiOperationId":"deleteBallot","summary":"Returns a ballot from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 ballot was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The ballot could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The ballot 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_541"},{"code":"429","description":"Limit exceeded... unable to delete ballot based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ballots/deleteballot"}],"panels":[]}]},"httpPath":"/ballots/{tenantId}/{id}"},{"label":"Returns a ballot from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/getballot","routeSlug":"/apis/membership/membership-v1/ballots/getballot","metadata":{"seo":{"title":"Returns a ballot from the system by its ID.","description":"This method will look up a ballot by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBallot","name":"Returns a ballot from the system by its ID.","isWebhook":false,"pointer":"/paths/~1ballots~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a ballot 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 ballot 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the ballot to return.","required":true}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/ballots/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/ballots/{tenantId}/{id}","href":"ballots/getballot","openApiOperationId":"getBallot","summary":"Returns a ballot from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 ballot was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}},"schemaId":"components/schemas/Ballot","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The ballot could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve ballot based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ballot","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ballots/getballot"}],"panels":[]}]},"httpPath":"/ballots/{tenantId}/{id}"},{"label":"Partially updates a ballot with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/patchballot","routeSlug":"/apis/membership/membership-v1/ballots/patchballot","metadata":{"seo":{"title":"Partially updates a ballot with the specified ID.","description":"This method will patch an existing ballot with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBallot","name":"Partially updates a ballot with the specified ID.","isWebhook":false,"pointer":"/paths/~1ballots~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a ballot 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 ballot 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the ballot to patch.","required":true}],"pointer":"/paths/~1ballots~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1ballots~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":"/ballots/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/ballots/{tenantId}/{id}","href":"ballots/patchballot","openApiOperationId":"patchBallot","summary":"Partially updates a ballot with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ballot was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}},"schemaId":"components/schemas/Ballot","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The ballot could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The ballot 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve ballot based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ballot","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ballots/patchballot"}],"panels":[]}]},"httpPath":"/ballots/{tenantId}/{id}"},{"label":"Updates a ballot with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/updateballot","routeSlug":"/apis/membership/membership-v1/ballots/updateballot","metadata":{"seo":{"title":"Updates a ballot with the specified ID.","description":"This method will update an existing ballot with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBallot","name":"Updates a ballot with the specified ID.","isWebhook":false,"pointer":"/paths/~1ballots~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a ballot 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 ballot 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the ballot to update.","required":true}],"pointer":"/paths/~1ballots~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/Ballot"}},"schemaId":"components/schemas/Ballot","pointer":"/paths/~1ballots~1{tenantId}~1{id}/put/requestBody","description":"The updated ballot that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/ballots/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Ballot"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/ballots/{tenantId}/{id}","href":"ballots/updateballot","openApiOperationId":"updateBallot","summary":"Updates a ballot with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Ballot","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Ballot"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The ballot was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}},"schemaId":"components/schemas/Ballot","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The ballot 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The ballot could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The ballot 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve ballot based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1ballots~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Ballot","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Ballot"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ballots/updateballot"}],"panels":[]}]},"httpPath":"/ballots/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Ballots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ballots","showPageActions":true},{"nodeType":"markdoc","content":"Ballots"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/ballots/{tenantId}","summary":"Creates a new ballot record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ballots/createballot","deprecated":false},{"title":"/ballots/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ballots/executebatchoperations","deprecated":false},{"title":"/ballots/{tenantId}/{id}","summary":"Returns a ballot from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ballots/deleteballot","deprecated":false},{"title":"/ballots/{tenantId}/{id}","summary":"Returns a ballot from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ballots/getballot","deprecated":false},{"title":"/ballots/{tenantId}/{id}","summary":"Partially updates a ballot with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/ballots/patchballot","deprecated":false},{"title":"/ballots/{tenantId}/{id}","summary":"Updates a ballot with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ballots/updateballot","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Notices","link":"/apis/membership/membership-v1/billing-notices","routeSlug":"/apis/membership/membership-v1/billing-notices","items":[{"label":"Gets all of the billing notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/listbillingnotices","routeSlug":"/apis/membership/membership-v1/billing-notices/listbillingnotices","metadata":{"seo":{"title":"Gets all of the billing notices in the system.","description":"This method will scan all billing notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBillingNotices","name":"Gets all of the billing notices in the system.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the billing 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 billing 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1billingNotices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingNotices/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingNotices/{tenantId}","href":"billing-notices/listbillingnotices","openApiOperationId":"listBillingNotices","summary":"Gets all of the billing notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}},"schemaId":"schema_550","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_550","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_550"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/listbillingnotices"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}"},{"label":"Creates a new billing notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/createbillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/createbillingnotice","metadata":{"seo":{"title":"Creates a new billing notice record that does not already exist.","description":"This method will auto-generate an ID and create a new billing notice. If an ID is specified for the billing notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingNotice","name":"Creates a new billing notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing 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 billing notice. If an ID is specified for the billing 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingNotices~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/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","pointer":"/paths/~1billingNotices~1{tenantId}/post/requestBody","description":"The billing notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingNotices/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}","href":"billing-notices/createbillingnotice","openApiOperationId":"createBillingNotice","summary":"Creates a new billing notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"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 notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The billing 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The billing 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_541"},{"code":"429","description":"Limit exceeded... unable to add billing 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/createbillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/executebatchoperations","routeSlug":"/apis/membership/membership-v1/billing-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/~1billingNotices~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingNotices~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/~1billingNotices~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingNotices/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/billingNotices/{tenantId}/batch","href":"billing-notices/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The billing 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve billing 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~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-notices/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/batch"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/previewemail","routeSlug":"/apis/membership/membership-v1/billing-notices/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/~1billingNotices~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_539","description":"The tenant","required":true}],"pointer":"/paths/~1billingNotices~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/~1billingNotices~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":"/billingNotices/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/billingNotices/{tenantId}/previewEmail","href":"billing-notices/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/previewemail"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/previewEmail"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/deletebillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/deletebillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will delete a billing notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingNotice","name":"Returns a billing notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing 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 billing 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the billing notice to delete.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/billingNotices/{tenantId}/{id}","href":"billing-notices/deletebillingnotice","openApiOperationId":"deleteBillingNotice","summary":"Returns a billing notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The billing 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_541"},{"code":"409","description":"The billing 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_541"},{"code":"429","description":"Limit exceeded... unable to delete billing 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/deletebillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/getbillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/getbillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will look up a billing notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingNotice","name":"Returns a billing notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing 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 billing 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the billing notice to return.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/getbillingnotice","openApiOperationId":"getBillingNotice","summary":"Returns a billing notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The billing 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve billing 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/getbillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Partially updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/patchbillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/patchbillingnotice","metadata":{"seo":{"title":"Partially updates a billing notice with the specified ID.","description":"This method will patch an existing billing notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingNotice","name":"Partially updates a billing notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing 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 billing 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the billing notice to patch.","required":true}],"pointer":"/paths/~1billingNotices~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1billingNotices~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":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/patchbillingnotice","openApiOperationId":"patchBillingNotice","summary":"Partially updates a billing notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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 notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The billing 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_541"},{"code":"409","description":"The billing 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve billing 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/patchbillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/updatebillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/updatebillingnotice","metadata":{"seo":{"title":"Updates a billing notice with the specified ID.","description":"This method will update an existing billing notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingNotice","name":"Updates a billing notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing 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 billing 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the billing notice to update.","required":true}],"pointer":"/paths/~1billingNotices~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/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/put/requestBody","description":"The updated billing notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/updatebillingnotice","openApiOperationId":"updateBillingNotice","summary":"Updates a billing notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"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 notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The billing 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The billing 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_541"},{"code":"409","description":"The billing 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve billing 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/updatebillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Notices","showPageActions":true},{"nodeType":"markdoc","content":"Billing Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingNotices/{tenantId}","summary":"Gets all of the billing notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-notices/listbillingnotices","deprecated":false},{"title":"/billingNotices/{tenantId}","summary":"Creates a new billing notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-notices/createbillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-notices/executebatchoperations","deprecated":false},{"title":"/billingNotices/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-notices/previewemail","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Returns a billing notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-notices/deletebillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Returns a billing notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-notices/getbillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Partially updates a billing notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-notices/patchbillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Updates a billing notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-notices/updatebillingnotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Run Actions","link":"/apis/membership/membership-v1/billing-run-actions","routeSlug":"/apis/membership/membership-v1/billing-run-actions","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-run-actions/listactionsbybillingrunid","routeSlug":"/apis/membership/membership-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_539","description":"The tenant","required":true},{"name":"billing_run_id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"billing_run_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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 membership_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/listactionsbymembershipid","routeSlug":"/apis/membership/membership-v1/billing-run-actions/listactionsbymembershipid","metadata":{"seo":{"title":"Returns a list of records with the specified membership_id","description":"Returns a list of records with the specified membership_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActionsByMembershipId","name":"Returns a list of records with the specified membership_id","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1membership~1{membership_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified membership_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 membership_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_539","description":"The tenant","required":true},{"name":"membership_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The membership_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1membership~1{membership_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1membership~1{membership_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/membership/{membership_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"membership_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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}/membership/{membership_id}","href":"billing-run-actions/listactionsbymembershipid","openApiOperationId":"listActionsByMembershipId","summary":"Returns a list of records with the specified membership_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1membership~1{membership_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/listactionsbymembershipid"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/membership/{membership_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/membership/membership-v1/billing-run-actions/getbillingrunaction","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-run-actions/patchbillingrunaction","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-run-actions/updatebillingrunaction","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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}/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}/membership/{membership_id}","summary":"Returns a list of records with the specified membership_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/listactionsbymembershipid","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/membership/membership-v1/billing-runs","routeSlug":"/apis/membership/membership-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/membership/membership-v1/billing-runs/createbillingrun","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-runs/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/generatebillingrunfromtemplate","routeSlug":"/apis/membership/membership-v1/billing-runs/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/~1billingRuns~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_539","description":"The tenant","required":true},{"name":"templateId","in":"path","schemaId":"schema_539","description":"The template","required":true},{"name":"referenceDate","in":"path","schemaId":"schema_539","description":"The reference date","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_539"},{"name":"referenceDate","in":"path","required":true,"schemaId":"schema_539"}],"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}/fromTemplate/{templateId}/{referenceDate}","href":"billing-runs/generatebillingrunfromtemplate","openApiOperationId":"generateBillingRunFromTemplate","summary":"Generates a billing run from a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/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/generatebillingrunfromtemplate"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"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/membership/membership-v1/billing-runs/listrunsbyrecurringbillingrunid","routeSlug":"/apis/membership/membership-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_539","description":"The tenant","required":true},{"name":"recurring_billing_run_id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"recurring_billing_run_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-runs/refreshbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-runs/searchforbillingruns","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-runs/deletebillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/billing-runs/getbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-runs/patchbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-runs/updatebillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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}/fromTemplate/{templateId}/{referenceDate}","summary":"Generates a billing run from a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-runs/generatebillingrunfromtemplate","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/membership/membership-v1/billing-templates","routeSlug":"/apis/membership/membership-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/membership/membership-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_551"}},"schemaId":"schema_551","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_551","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_551"}}},{"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/membership/membership-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-templates/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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}/{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":"Change Fees","link":"/apis/membership/membership-v1/change-fees","routeSlug":"/apis/membership/membership-v1/change-fees","items":[{"label":"Gets all of the change fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/listchangefees","routeSlug":"/apis/membership/membership-v1/change-fees/listchangefees","metadata":{"seo":{"title":"Gets all of the change fees in the system.","description":"This method will scan all change fees and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChangeFees","name":"Gets all of the change fees in the system.","isWebhook":false,"pointer":"/paths/~1changeFees~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the change 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 change 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1changeFees~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1changeFees~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/changeFees/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/changeFees/{tenantId}","href":"change-fees/listchangefees","openApiOperationId":"listChangeFees","summary":"Gets all of the change fees in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 change feeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_552"}},"schemaId":"schema_552","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_552","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_552"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-fees/listchangefees"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}"},{"label":"Creates a new change fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/createchangefee","routeSlug":"/apis/membership/membership-v1/change-fees/createchangefee","metadata":{"seo":{"title":"Creates a new change fee record that does not already exist.","description":"This method will auto-generate an ID and create a new change fee. If an ID is specified for the change fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChangeFee","name":"Creates a new change fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1changeFees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new change 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 change fee. If an ID is specified for the change 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1changeFees~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/ChangeFee"}},"schemaId":"components/schemas/ChangeFee","pointer":"/paths/~1changeFees~1{tenantId}/post/requestBody","description":"The change fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/changeFees/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/changeFees/{tenantId}","href":"change-fees/createchangefee","openApiOperationId":"createChangeFee","summary":"Creates a new change fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChangeFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The change fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"schemaId":"components/schemas/ChangeFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The change 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The change 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_541"},{"code":"429","description":"Limit exceeded... unable to add change 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChangeFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-fees/createchangefee"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/executebatchoperations","routeSlug":"/apis/membership/membership-v1/change-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/~1changeFees~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1changeFees~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/~1changeFees~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/changeFees/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/changeFees/{tenantId}/batch","href":"change-fees/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The change 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve change 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~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":"/change-fees/executebatchoperations"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}/batch"},{"label":"Returns a change fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/deletechangefee","routeSlug":"/apis/membership/membership-v1/change-fees/deletechangefee","metadata":{"seo":{"title":"Returns a change fee from the system by its ID.","description":"This method will delete a change fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChangeFee","name":"Returns a change fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a change 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 change 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the change fee to delete.","required":true}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/changeFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/changeFees/{tenantId}/{id}","href":"change-fees/deletechangefee","openApiOperationId":"deleteChangeFee","summary":"Returns a change fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 change fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The change 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_541"},{"code":"409","description":"The change 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_541"},{"code":"429","description":"Limit exceeded... unable to delete change 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-fees/deletechangefee"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}/{id}"},{"label":"Returns a change fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/getchangefee","routeSlug":"/apis/membership/membership-v1/change-fees/getchangefee","metadata":{"seo":{"title":"Returns a change fee from the system by its ID.","description":"This method will look up a change fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChangeFee","name":"Returns a change fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a change 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 change 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the change fee to return.","required":true}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/changeFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/changeFees/{tenantId}/{id}","href":"change-fees/getchangefee","openApiOperationId":"getChangeFee","summary":"Returns a change fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 change fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"schemaId":"components/schemas/ChangeFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The change 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve change 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChangeFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-fees/getchangefee"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}/{id}"},{"label":"Partially updates a change fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/patchchangefee","routeSlug":"/apis/membership/membership-v1/change-fees/patchchangefee","metadata":{"seo":{"title":"Partially updates a change fee with the specified ID.","description":"This method will patch an existing change fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchChangeFee","name":"Partially updates a change fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a change 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 change 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the change fee to patch.","required":true}],"pointer":"/paths/~1changeFees~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1changeFees~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":"/changeFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/changeFees/{tenantId}/{id}","href":"change-fees/patchchangefee","openApiOperationId":"patchChangeFee","summary":"Partially updates a change fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The change fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"schemaId":"components/schemas/ChangeFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The change 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_541"},{"code":"409","description":"The change 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve change 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChangeFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-fees/patchchangefee"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}/{id}"},{"label":"Updates a change fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/updatechangefee","routeSlug":"/apis/membership/membership-v1/change-fees/updatechangefee","metadata":{"seo":{"title":"Updates a change fee with the specified ID.","description":"This method will update an existing change fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChangeFee","name":"Updates a change fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a change 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 change 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the change fee to update.","required":true}],"pointer":"/paths/~1changeFees~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/ChangeFee"}},"schemaId":"components/schemas/ChangeFee","pointer":"/paths/~1changeFees~1{tenantId}~1{id}/put/requestBody","description":"The updated change fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/changeFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/changeFees/{tenantId}/{id}","href":"change-fees/updatechangefee","openApiOperationId":"updateChangeFee","summary":"Updates a change fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChangeFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The change fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}},"schemaId":"components/schemas/ChangeFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The change 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The change 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_541"},{"code":"409","description":"The change 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve change 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1changeFees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChangeFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-fees/updatechangefee"}],"panels":[]}]},"httpPath":"/changeFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Change Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Fees","showPageActions":true},{"nodeType":"markdoc","content":"Change Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/changeFees/{tenantId}","summary":"Gets all of the change fees in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/change-fees/listchangefees","deprecated":false},{"title":"/changeFees/{tenantId}","summary":"Creates a new change fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/change-fees/createchangefee","deprecated":false},{"title":"/changeFees/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/change-fees/executebatchoperations","deprecated":false},{"title":"/changeFees/{tenantId}/{id}","summary":"Returns a change fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/change-fees/deletechangefee","deprecated":false},{"title":"/changeFees/{tenantId}/{id}","summary":"Returns a change fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/change-fees/getchangefee","deprecated":false},{"title":"/changeFees/{tenantId}/{id}","summary":"Partially updates a change fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/change-fees/patchchangefee","deprecated":false},{"title":"/changeFees/{tenantId}/{id}","summary":"Updates a change fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/change-fees/updatechangefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Chapter Dues Products","link":"/apis/membership/membership-v1/chapter-dues-products","routeSlug":"/apis/membership/membership-v1/chapter-dues-products","items":[{"label":"Gets all of the chapter dues products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/listchapterduesproducts","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/listchapterduesproducts","metadata":{"seo":{"title":"Gets all of the chapter dues products in the system.","description":"This method will scan all chapter dues products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChapterDuesProducts","name":"Gets all of the chapter dues products in the system.","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the chapter dues products 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 chapter dues products 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapterDuesProducts/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapterDuesProducts/{tenantId}","href":"chapter-dues-products/listchapterduesproducts","openApiOperationId":"listChapterDuesProducts","summary":"Gets all of the chapter dues products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter dues productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}},"schemaId":"schema_553","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_553","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_553"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/listchapterduesproducts"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}"},{"label":"Creates a new chapter dues product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/createchapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/createchapterduesproduct","metadata":{"seo":{"title":"Creates a new chapter dues product record that does not already exist.","description":"This method will auto-generate an ID and create a new chapter dues product. If an ID is specified for the chapter dues product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChapterDuesProduct","name":"Creates a new chapter dues product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new chapter dues product 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 chapter dues product. If an ID is specified for the chapter dues product, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapterDuesProducts~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/ChapterDuesProduct"}},"schemaId":"components/schemas/ChapterDuesProduct","pointer":"/paths/~1chapterDuesProducts~1{tenantId}/post/requestBody","description":"The chapter dues product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapterDuesProducts/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapterDuesProducts/{tenantId}","href":"chapter-dues-products/createchapterduesproduct","openApiOperationId":"createChapterDuesProduct","summary":"Creates a new chapter dues product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChapterDuesProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter dues product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"schemaId":"components/schemas/ChapterDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter dues product 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The chapter dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to add chapter dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/createchapterduesproduct"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/executebatchoperations","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/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/~1chapterDuesProducts~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapterDuesProducts~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/~1chapterDuesProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapterDuesProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapterDuesProducts/{tenantId}/batch","href":"chapter-dues-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~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":"/chapter-dues-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}/batch"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/listproductsbychapterid","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/listproductsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductsByChapterId","name":"Returns a list of records with the specified chapter_id","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1chapter~1{chapter_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified chapter_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 chapter_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_539","description":"The tenant","required":true},{"name":"chapter_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chapter_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1chapter~1{chapter_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1chapter~1{chapter_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapterDuesProducts/{tenantId}/chapter/{chapter_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapter_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapterDuesProducts/{tenantId}/chapter/{chapter_id}","href":"chapter-dues-products/listproductsbychapterid","openApiOperationId":"listProductsByChapterId","summary":"Returns a list of records with the specified chapter_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListChapterDuesProductsResponse"}},"schemaId":"components/schemas/ListChapterDuesProductsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1chapter~1{chapter_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListChapterDuesProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListChapterDuesProductsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/listproductsbychapterid"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}/chapter/{chapter_id}"},{"label":"Returns a chapter dues product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/deletechapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/deletechapterduesproduct","metadata":{"seo":{"title":"Returns a chapter dues product from the system by its ID.","description":"This method will delete a chapter dues product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChapterDuesProduct","name":"Returns a chapter dues product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a chapter dues product 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 chapter dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter dues product to delete.","required":true}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chapterDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapterDuesProducts/{tenantId}/{id}","href":"chapter-dues-products/deletechapterduesproduct","openApiOperationId":"deleteChapterDuesProduct","summary":"Returns a chapter dues product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter dues product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The chapter dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to delete chapter dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/deletechapterduesproduct"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"},{"label":"Returns a chapter dues product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/getchapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/getchapterduesproduct","metadata":{"seo":{"title":"Returns a chapter dues product from the system by its ID.","description":"This method will look up a chapter dues product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChapterDuesProduct","name":"Returns a chapter dues product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a chapter dues product 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 chapter dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter dues product to return.","required":true}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapterDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapterDuesProducts/{tenantId}/{id}","href":"chapter-dues-products/getchapterduesproduct","openApiOperationId":"getChapterDuesProduct","summary":"Returns a chapter dues product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter dues product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"schemaId":"components/schemas/ChapterDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/getchapterduesproduct"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"},{"label":"Partially updates a chapter dues product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/patchchapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/patchchapterduesproduct","metadata":{"seo":{"title":"Partially updates a chapter dues product with the specified ID.","description":"This method will patch an existing chapter dues product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchChapterDuesProduct","name":"Partially updates a chapter dues product with the specified ID.","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a chapter dues product 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 chapter dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter dues product to patch.","required":true}],"pointer":"/paths/~1chapterDuesProducts~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1chapterDuesProducts~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":"/chapterDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapterDuesProducts/{tenantId}/{id}","href":"chapter-dues-products/patchchapterduesproduct","openApiOperationId":"patchChapterDuesProduct","summary":"Partially updates a chapter dues product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter dues product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"schemaId":"components/schemas/ChapterDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The chapter dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/patchchapterduesproduct"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"},{"label":"Updates a chapter dues product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/updatechapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/updatechapterduesproduct","metadata":{"seo":{"title":"Updates a chapter dues product with the specified ID.","description":"This method will update an existing chapter dues product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChapterDuesProduct","name":"Updates a chapter dues product with the specified ID.","isWebhook":false,"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a chapter dues product 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 chapter dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter dues product to update.","required":true}],"pointer":"/paths/~1chapterDuesProducts~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/ChapterDuesProduct"}},"schemaId":"components/schemas/ChapterDuesProduct","pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated chapter dues product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chapterDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapterDuesProducts/{tenantId}/{id}","href":"chapter-dues-products/updatechapterduesproduct","openApiOperationId":"updateChapterDuesProduct","summary":"Updates a chapter dues product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChapterDuesProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter dues product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}},"schemaId":"components/schemas/ChapterDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter dues product 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The chapter dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterDuesProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-dues-products/updatechapterduesproduct"}],"panels":[]}]},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Chapter Dues Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chapter Dues Products","showPageActions":true},{"nodeType":"markdoc","content":"Chapter Dues Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/chapterDuesProducts/{tenantId}","summary":"Gets all of the chapter dues products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapter-dues-products/listchapterduesproducts","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}","summary":"Creates a new chapter dues product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapter-dues-products/createchapterduesproduct","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapter-dues-products/executebatchoperations","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}/chapter/{chapter_id}","summary":"Returns a list of records with the specified chapter_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapter-dues-products/listproductsbychapterid","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}/{id}","summary":"Returns a chapter dues product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chapter-dues-products/deletechapterduesproduct","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}/{id}","summary":"Returns a chapter dues product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapter-dues-products/getchapterduesproduct","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}/{id}","summary":"Partially updates a chapter dues product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/chapter-dues-products/patchchapterduesproduct","deprecated":false},{"title":"/chapterDuesProducts/{tenantId}/{id}","summary":"Updates a chapter dues product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chapter-dues-products/updatechapterduesproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Chapter Types","link":"/apis/membership/membership-v1/chapter-types","routeSlug":"/apis/membership/membership-v1/chapter-types","items":[{"label":"Gets all of the chapter types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/listchaptertypes","routeSlug":"/apis/membership/membership-v1/chapter-types/listchaptertypes","metadata":{"seo":{"title":"Gets all of the chapter types in the system.","description":"This method will scan all chapter types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChapterTypes","name":"Gets all of the chapter types in the system.","isWebhook":false,"pointer":"/paths/~1chapterTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapterTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1chapterTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapterTypes/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapterTypes/{tenantId}","href":"chapter-types/listchaptertypes","openApiOperationId":"listChapterTypes","summary":"Gets all of the chapter types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}},"schemaId":"schema_554","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_554","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_554"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-types/listchaptertypes"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}"},{"label":"Creates a new chapter type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/createchaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/createchaptertype","metadata":{"seo":{"title":"Creates a new chapter type record that does not already exist.","description":"This method will auto-generate an ID and create a new chapter type. If an ID is specified for the chapter type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChapterType","name":"Creates a new chapter type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1chapterTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new chapter 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 chapter type. If an ID is specified for the chapter 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapterTypes~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/ChapterType"}},"schemaId":"components/schemas/ChapterType","pointer":"/paths/~1chapterTypes~1{tenantId}/post/requestBody","description":"The chapter type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapterTypes/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/chapterTypes/{tenantId}","href":"chapter-types/createchaptertype","openApiOperationId":"createChapterType","summary":"Creates a new chapter type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChapterType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"schemaId":"components/schemas/ChapterType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to add chapter 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-types/createchaptertype"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/chapter-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/~1chapterTypes~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapterTypes~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/~1chapterTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapterTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapterTypes/{tenantId}/batch","href":"chapter-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~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":"/chapter-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}/batch"},{"label":"Returns a chapter type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/deletechaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/deletechaptertype","metadata":{"seo":{"title":"Returns a chapter type from the system by its ID.","description":"This method will delete a chapter type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChapterType","name":"Returns a chapter type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter type to delete.","required":true}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chapterTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapterTypes/{tenantId}/{id}","href":"chapter-types/deletechaptertype","openApiOperationId":"deleteChapterType","summary":"Returns a chapter type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter 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_541"},{"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_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to delete chapter 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-types/deletechaptertype"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}/{id}"},{"label":"Returns a chapter type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/getchaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/getchaptertype","metadata":{"seo":{"title":"Returns a chapter type from the system by its ID.","description":"This method will look up a chapter type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChapterType","name":"Returns a chapter type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter type to return.","required":true}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapterTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapterTypes/{tenantId}/{id}","href":"chapter-types/getchaptertype","openApiOperationId":"getChapterType","summary":"Returns a chapter type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"schemaId":"components/schemas/ChapterType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-types/getchaptertype"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}/{id}"},{"label":"Partially updates a chapter type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/patchchaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/patchchaptertype","metadata":{"seo":{"title":"Partially updates a chapter type with the specified ID.","description":"This method will patch an existing chapter type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchChapterType","name":"Partially updates a chapter type with the specified ID.","isWebhook":false,"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter type to patch.","required":true}],"pointer":"/paths/~1chapterTypes~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1chapterTypes~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":"/chapterTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/chapterTypes/{tenantId}/{id}","href":"chapter-types/patchchaptertype","openApiOperationId":"patchChapterType","summary":"Partially updates a chapter type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"schemaId":"components/schemas/ChapterType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter 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_541"},{"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_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-types/patchchaptertype"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}/{id}"},{"label":"Updates a chapter type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/updatechaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/updatechaptertype","metadata":{"seo":{"title":"Updates a chapter type with the specified ID.","description":"This method will update an existing chapter type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChapterType","name":"Updates a chapter type with the specified ID.","isWebhook":false,"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter type to update.","required":true}],"pointer":"/paths/~1chapterTypes~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/ChapterType"}},"schemaId":"components/schemas/ChapterType","pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated chapter type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chapterTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/chapterTypes/{tenantId}/{id}","href":"chapter-types/updatechaptertype","openApiOperationId":"updateChapterType","summary":"Updates a chapter type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChapterType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}},"schemaId":"components/schemas/ChapterType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter 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_541"},{"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_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapterTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapter-types/updatechaptertype"}],"panels":[]}]},"httpPath":"/chapterTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Chapter Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chapter Types","showPageActions":true},{"nodeType":"markdoc","content":"Chapter Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/chapterTypes/{tenantId}","summary":"Gets all of the chapter types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapter-types/listchaptertypes","deprecated":false},{"title":"/chapterTypes/{tenantId}","summary":"Creates a new chapter type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapter-types/createchaptertype","deprecated":false},{"title":"/chapterTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapter-types/executebatchoperations","deprecated":false},{"title":"/chapterTypes/{tenantId}/{id}","summary":"Returns a chapter type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chapter-types/deletechaptertype","deprecated":false},{"title":"/chapterTypes/{tenantId}/{id}","summary":"Returns a chapter type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapter-types/getchaptertype","deprecated":false},{"title":"/chapterTypes/{tenantId}/{id}","summary":"Partially updates a chapter type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/chapter-types/patchchaptertype","deprecated":false},{"title":"/chapterTypes/{tenantId}/{id}","summary":"Updates a chapter type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chapter-types/updatechaptertype","deprecated":false}]}]}]}]}},{"type":"group","label":"Chapters","link":"/apis/membership/membership-v1/chapters","routeSlug":"/apis/membership/membership-v1/chapters","items":[{"label":"Gets all of the chapters in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/listchapters","routeSlug":"/apis/membership/membership-v1/chapters/listchapters","metadata":{"seo":{"title":"Gets all of the chapters in the system.","description":"This method will scan all chapters and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChapters","name":"Gets all of the chapters in the system.","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the chapters 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 chapters 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapters~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1chapters~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}","href":"chapters/listchapters","openApiOperationId":"listChapters","summary":"Gets all of the chapters in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapterswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_555"}},"schemaId":"schema_555","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_555","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_555"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/listchapters"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}"},{"label":"Creates a new chapter record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/createchapter","routeSlug":"/apis/membership/membership-v1/chapters/createchapter","metadata":{"seo":{"title":"Creates a new chapter record that does not already exist.","description":"This method will auto-generate an ID and create a new chapter. If an ID is specified for the chapter, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChapter","name":"Creates a new chapter record that does not already exist.","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new chapter 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 chapter. If an ID is specified for the chapter, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapters~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/Chapter"}},"schemaId":"components/schemas/Chapter","pointer":"/paths/~1chapters~1{tenantId}/post/requestBody","description":"The chapter that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Chapter"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapters/{tenantId}","href":"chapters/createchapter","openApiOperationId":"createChapter","summary":"Creates a new chapter record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Chapter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Chapter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}},"schemaId":"components/schemas/Chapter","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to add chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Chapter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/createchapter"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/executebatchoperations","routeSlug":"/apis/membership/membership-v1/chapters/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/~1chapters~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapters~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/~1chapters~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/batch","href":"chapters/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~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":"/chapters/executebatchoperations"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/batch"},{"label":"Change chapter committee terms","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/patchchaptercommittee","routeSlug":"/apis/membership/membership-v1/chapters/patchchaptercommittee","metadata":{"seo":{"title":"Change chapter committee terms","description":"Allows for chapter administrators to change committee terms"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchChapterCommittee","name":"Change chapter committee terms","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1committee~1{chapterId}~1{committeeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change chapter committee terms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for chapter administrators to change committee terms"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"committeeId","in":"path","schemaId":"schema_539","description":"The committee Id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1committee~1{chapterId}~1{committeeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"schemaId":"schema_542","pointer":"/paths/~1chapters~1{tenantId}~1committee~1{chapterId}~1{committeeId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/chapters/{tenantId}/committee/{chapterId}/{committeeId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"committeeId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/committee/{chapterId}/{committeeId}","href":"chapters/patchchaptercommittee","openApiOperationId":"patchChapterCommittee","summary":"Change chapter committee terms"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1committee~1{chapterId}~1{committeeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/patchchaptercommittee"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/committee/{chapterId}/{committeeId}"},{"label":"Create a chapter committee membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/createchaptercommitteemembership","routeSlug":"/apis/membership/membership-v1/chapters/createchaptercommitteemembership","metadata":{"seo":{"title":"Create a chapter committee membership","description":"Add a membership to a chapter committee"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChapterCommitteeMembership","name":"Create a chapter committee membership","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a chapter committee membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a membership to a chapter committee"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}/post/requestBody","description":"The membership"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/committeeMembership/{chapterId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/committeeMembership/{chapterId}","href":"chapters/createchaptercommitteemembership","openApiOperationId":"createChapterCommitteeMembership","summary":"Create a chapter committee membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/createchaptercommitteemembership"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/committeeMembership/{chapterId}"},{"label":"Delete a chapter committee membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/deletechaptercommitteemembership","routeSlug":"/apis/membership/membership-v1/chapters/deletechaptercommitteemembership","metadata":{"seo":{"title":"Delete a chapter committee membership","description":"Changes a chapter committee membership"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChapterCommitteeMembership","name":"Delete a chapter committee membership","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a chapter committee membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes a chapter committee membership"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The committee membership id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}","href":"chapters/deletechaptercommitteemembership","openApiOperationId":"deleteChapterCommitteeMembership","summary":"Delete a chapter committee membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/deletechaptercommitteemembership"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}"},{"label":"Update a chapter committee membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechaptercommitteemembership","routeSlug":"/apis/membership/membership-v1/chapters/updatechaptercommitteemembership","metadata":{"seo":{"title":"Update a chapter committee membership","description":"Changes a chapter committee membership"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChapterCommitteeMembership","name":"Update a chapter committee membership","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a chapter committee membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes a chapter committee membership"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The committee membership id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/put/requestBody","description":"The membership"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}","href":"chapters/updatechaptercommitteemembership","openApiOperationId":"updateChapterCommitteeMembership","summary":"Update a chapter committee membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1committeeMembership~1{chapterId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/updatechaptercommitteemembership"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}"},{"label":"Creates a new contact on behalf of a chapter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/createchaptermembercontact","routeSlug":"/apis/membership/membership-v1/chapters/createchaptermembercontact","metadata":{"seo":{"title":"Creates a new contact on behalf of a chapter","description":"Allows for a portal user to update the contact info of a chapter member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createChapterMemberContact","name":"Creates a new contact on behalf of a chapter","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new contact on behalf of a chapter","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 the contact info of a chapter member"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}/post/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/contact/{chapterId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/contact/{chapterId}","href":"chapters/createchaptermembercontact","openApiOperationId":"createChapterMemberContact","summary":"Creates a new contact on behalf of a chapter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/createchaptermembercontact"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/contact/{chapterId}"},{"label":"Get chapter member contact info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/getchaptermembercontact","routeSlug":"/apis/membership/membership-v1/chapters/getchaptermembercontact","metadata":{"seo":{"title":"Get chapter member contact info","description":"Allows for a portal user to get the contact info of a chapter member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChapterMemberContact","name":"Get chapter member contact info","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get chapter member contact info","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 the contact info of a chapter member"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"contactId","in":"path","schemaId":"schema_539","description":"The contactId","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/contact/{chapterId}/{contactId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/contact/{chapterId}/{contactId}","href":"chapters/getchaptermembercontact","openApiOperationId":"getChapterMemberContact","summary":"Get chapter member contact info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/getchaptermembercontact"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/contact/{chapterId}/{contactId}"},{"label":"Update chapter member contact info","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechaptermembercontact","routeSlug":"/apis/membership/membership-v1/chapters/updatechaptermembercontact","metadata":{"seo":{"title":"Update chapter member contact info","description":"Allows for a portal user to update the contact info of a chapter member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChapterMemberContact","name":"Update chapter member contact info","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update chapter member contact info","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 the contact info of a chapter member"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"contactId","in":"path","schemaId":"schema_539","description":"The contactId","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/put/requestBody","description":"The contact"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chapters/{tenantId}/contact/{chapterId}/{contactId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/contact/{chapterId}/{contactId}","href":"chapters/updatechaptermembercontact","openApiOperationId":"updateChapterMemberContact","summary":"Update chapter member contact info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1contact~1{chapterId}~1{contactId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/updatechaptermembercontact"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/contact/{chapterId}/{contactId}"},{"label":"Generates an application for a contact or organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/generatechaptermembershipapplication","routeSlug":"/apis/membership/membership-v1/chapters/generatechaptermembershipapplication","metadata":{"seo":{"title":"Generates an application for a contact or organization","description":"Generates an application for a contact or organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateChapterMembershipApplication","name":"Generates an application for a contact or organization","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1generateApplication~1{chapterId}~1{processId}~1{ownerType}~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an application 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_539","description":"The id of the tenant being accessed","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"processId","in":"path","schemaId":"schema_539","description":"The process id","required":true},{"name":"ownerType","in":"path","schemaId":"schema_547","description":"The contact or organization type","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The contact or organization type","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1generateApplication~1{chapterId}~1{processId}~1{ownerType}~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"processId","in":"path","required":true,"schemaId":"schema_539"},{"name":"ownerType","in":"path","required":true,"schemaId":"schema_547"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}","href":"chapters/generatechaptermembershipapplication","openApiOperationId":"generateChapterMembershipApplication","summary":"Generates an application for a contact or organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1generateApplication~1{chapterId}~1{processId}~1{ownerType}~1{id}/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":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/generatechaptermembershipapplication"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}"},{"label":"Generates an order from a membership application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/generatechaptermembershiporder","routeSlug":"/apis/membership/membership-v1/chapters/generatechaptermembershiporder","metadata":{"seo":{"title":"Generates an order from a membership application","description":"This method will examine a membership application and generate an appropriate order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateChapterMembershipOrder","name":"Generates an order from a membership application","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1generateOrder~1{chapterId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates an order from a membership 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 membership 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_539","description":"The id of the tenant being accessed","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1generateOrder~1{chapterId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1chapters~1{tenantId}~1generateOrder~1{chapterId}/post/requestBody","description":"The application to generate an order"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/generateOrder/{chapterId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/generateOrder/{chapterId}","href":"chapters/generatechaptermembershiporder","openApiOperationId":"generateChapterMembershipOrder","summary":"Generates an order from a membership application"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1generateOrder~1{chapterId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/generatechaptermembershiporder"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/generateOrder/{chapterId}"},{"label":"Update chapter member membership info","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechaptermembermembership","routeSlug":"/apis/membership/membership-v1/chapters/updatechaptermembermembership","metadata":{"seo":{"title":"Update chapter member membership info","description":"Allows for a portal user to update the membership info of a chapter member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChapterMemberMembership","name":"Update chapter member membership info","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1membership~1{chapterId}~1{membershipId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update chapter member membership info","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 the membership info of a chapter member"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"membershipId","in":"path","schemaId":"schema_539","description":"The membershipId","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1membership~1{chapterId}~1{membershipId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"schemaId":"schema_549","pointer":"/paths/~1chapters~1{tenantId}~1membership~1{chapterId}~1{membershipId}/put/requestBody","description":"The membership"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chapters/{tenantId}/membership/{chapterId}/{membershipId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"membershipId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_549"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/membership/{chapterId}/{membershipId}","href":"chapters/updatechaptermembermembership","openApiOperationId":"updateChapterMemberMembership","summary":"Update chapter member membership info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_549"}},"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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1membership~1{chapterId}~1{membershipId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/updatechaptermembermembership"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/membership/{chapterId}/{membershipId}"},{"label":"Returns a list of chapters for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/describechaptersformembershippackage","routeSlug":"/apis/membership/membership-v1/chapters/describechaptersformembershippackage","metadata":{"seo":{"title":"Returns a list of chapters for a given membership package","description":"Returns a list of chapters for a given membership package"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeChaptersForMembershipPackage","name":"Returns a list of chapters for a given membership package","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of chapters for a given membership package","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 chapters for a given membership package"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"membershipPackageId","in":"path","schemaId":"schema_539","description":"The membership package to describe chapters","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currencyCode","in":"query","schemaId":"schema_539","description":"The membership package to describe sections"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"membershipPackageId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"currencyCode","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}","href":"chapters/describechaptersformembershippackage","openApiOperationId":"describeChaptersForMembershipPackage","summary":"Returns a list of chapters for a given membership package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ChapterDescriptionResult"}},"schemaId":"components/schemas/ChapterDescriptionResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterDescriptionResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDescriptionResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/describechaptersformembershippackage"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}"},{"label":"Returns a list of chapters for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/describechaptersformembershippackageandmember","routeSlug":"/apis/membership/membership-v1/chapters/describechaptersformembershippackageandmember","metadata":{"seo":{"title":"Returns a list of chapters for a given membership package","description":"Returns a list of chapters for a given membership package"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeChaptersForMembershipPackageAndMember","name":"Returns a list of chapters for a given membership package","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of chapters for a given membership package","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 chapters for a given membership package"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"membershipPackageId","in":"path","schemaId":"schema_539","description":"The membership package to describe chapters","required":true},{"name":"memberType","in":"path","schemaId":"schema_539","description":"The membership package to describe chapters","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_539","description":"The membership package to describe chapters","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currencyCode","in":"query","schemaId":"schema_539","description":"The membership package to describe sections"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}/{memberType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"membershipPackageId","in":"path","required":true,"schemaId":"schema_539"},{"name":"memberType","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"currencyCode","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}/{memberType}/{contactOrOrganizationId}","href":"chapters/describechaptersformembershippackageandmember","openApiOperationId":"describeChaptersForMembershipPackageAndMember","summary":"Returns a list of chapters for a given membership package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ChapterDescriptionResult"}},"schemaId":"components/schemas/ChapterDescriptionResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1describeChapters~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChapterDescriptionResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChapterDescriptionResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/describechaptersformembershippackageandmember"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}/{memberType}/{contactOrOrganizationId}"},{"label":"Searches for the nearest chapters to the latitude and longitude supplied","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/findnearestchapter","routeSlug":"/apis/membership/membership-v1/chapters/findnearestchapter","metadata":{"seo":{"title":"Searches for the nearest chapters to the latitude and longitude supplied","description":"Returns a list of chapters for a given membership package"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findNearestChapter","name":"Searches for the nearest chapters to the latitude and longitude supplied","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1portal~1findNearest~1{latitude}~1{longitude}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for the nearest chapters to the latitude and longitude supplied","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 chapters for a given membership package"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"longitude","in":"path","schemaId":"schema_539","description":"Longitude","required":true},{"name":"latitude","in":"path","schemaId":"schema_539","description":"Latitue","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1findNearest~1{latitude}~1{longitude}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"maximumNumberOfResults","in":"query","schemaId":"schema_556","description":"Max results"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1findNearest~1{latitude}~1{longitude}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/portal/findNearest/{latitude}/{longitude}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"longitude","in":"path","required":true,"schemaId":"schema_539"},{"name":"latitude","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"maximumNumberOfResults","in":"query","required":false,"schemaId":"schema_556"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/portal/findNearest/{latitude}/{longitude}","href":"chapters/findnearestchapter","openApiOperationId":"findNearestChapter","summary":"Searches for the nearest chapters to the latitude and longitude supplied"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/FindNearestChaptersResult"}},"schemaId":"components/schemas/FindNearestChaptersResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1findNearest~1{latitude}~1{longitude}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FindNearestChaptersResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FindNearestChaptersResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/findnearestchapter"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/portal/findNearest/{latitude}/{longitude}"},{"label":"Get eligible application processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/geteligibleappprocesses","routeSlug":"/apis/membership/membership-v1/chapters/geteligibleappprocesses","metadata":{"seo":{"title":"Get eligible application processes","description":"Get eligible application processes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEligibleAppProcesses","name":"Get eligible application processes","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1portal~1getEligibleAppProcesses~1{chapterId}~1{contactId}/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":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"Parameters to the query","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter ID","required":true},{"name":"contactId","in":"path","schemaId":"schema_539","description":"The contact ID","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1getEligibleAppProcesses~1{chapterId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}","href":"chapters/geteligibleappprocesses","openApiOperationId":"getEligibleAppProcesses","summary":"Get eligible application processes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1portal~1getEligibleAppProcesses~1{chapterId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/geteligibleappprocesses"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}"},{"label":"Get portal permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/getportalpermissions","routeSlug":"/apis/membership/membership-v1/chapters/getportalpermissions","metadata":{"seo":{"title":"Get portal permissions","description":"Determines the permissions available in the portal for a portal user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPortalPermissions","name":"Get portal permissions","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1portalPermissions~1{chapterId}~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get portal permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Determines the permissions available in the portal for a portal user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true},{"name":"contactId","in":"path","schemaId":"schema_539","description":"The contact id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1portalPermissions~1{chapterId}~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}","href":"chapters/getportalpermissions","openApiOperationId":"getPortalPermissions","summary":"Get portal permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/PortalPermissionsResult"}},"schemaId":"components/schemas/PortalPermissionsResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1portalPermissions~1{chapterId}~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortalPermissionsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortalPermissionsResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/getportalpermissions"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}"},{"label":"Runs a saved query on behalf of a chapter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/runchapterquery","routeSlug":"/apis/membership/membership-v1/chapters/runchapterquery","metadata":{"seo":{"title":"Runs a saved query on behalf of a chapter","description":"Runs a saved query on behalf of a chapter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runChapterQuery","name":"Runs a saved query on behalf of a chapter","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1query~1{chapterId}~1{savedQueryId}~1{outputFormat}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Runs a saved query on behalf of a chapter","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_539","description":"Parameters to the query","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The saved query ID","required":true},{"name":"savedQueryId","in":"path","schemaId":"schema_539","description":"The saved query ID","required":true},{"name":"outputFormat","in":"path","schemaId":"schema_539","description":"The output format of the query","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1query~1{chapterId}~1{savedQueryId}~1{outputFormat}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/query/{chapterId}/{savedQueryId}/{outputFormat}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"},{"name":"savedQueryId","in":"path","required":true,"schemaId":"schema_539"},{"name":"outputFormat","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/query/{chapterId}/{savedQueryId}/{outputFormat}","href":"chapters/runchapterquery","openApiOperationId":"runChapterQuery","summary":"Runs a saved query on behalf of a chapter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1query~1{chapterId}~1{savedQueryId}~1{outputFormat}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/runchapterquery"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/query/{chapterId}/{savedQueryId}/{outputFormat}"},{"label":"View chapter roster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/viewchapterroster","routeSlug":"/apis/membership/membership-v1/chapters/viewchapterroster","metadata":{"seo":{"title":"View chapter roster","description":"Allows for a portal user to view the roster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"viewChapterRoster","name":"View chapter roster","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1roster~1{chapterId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View chapter roster","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 view the roster"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"chapterId","in":"path","schemaId":"schema_539","description":"The chapter id","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1roster~1{chapterId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1chapters~1{tenantId}~1roster~1{chapterId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/roster/{chapterId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapterId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/roster/{chapterId}","href":"chapters/viewchapterroster","openApiOperationId":"viewChapterRoster","summary":"View chapter roster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/PagedSearchResults"}},"schemaId":"components/schemas/PagedSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1roster~1{chapterId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/viewchapterroster"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/roster/{chapterId}"},{"label":"Searches for chapters using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/searchforchapters","routeSlug":"/apis/membership/membership-v1/chapters/searchforchapters","metadata":{"seo":{"title":"Searches for chapters using predefined parameters","description":"Searches for chapters using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForChapters","name":"Searches for chapters using predefined parameters","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for chapters 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 chapters 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_539","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1chapters~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/ChapterSearchParameters"}},"schemaId":"components/schemas/ChapterSearchParameters","pointer":"/paths/~1chapters~1{tenantId}~1search/post/requestBody","description":"The chapter that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/chapters/{tenantId}/search","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ChapterSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapters/{tenantId}/search","href":"chapters/searchforchapters","openApiOperationId":"searchForChapters","summary":"Searches for chapters using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ChapterSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ChapterSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedChapterSearchResults"}},"schemaId":"components/schemas/PagedChapterSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to add chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedChapterSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedChapterSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/searchforchapters"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/search"},{"label":"Returns a chapter from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/deletechapter","routeSlug":"/apis/membership/membership-v1/chapters/deletechapter","metadata":{"seo":{"title":"Returns a chapter from the system by its ID.","description":"This method will delete a chapter with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteChapter","name":"Returns a chapter from the system by its ID.","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter to delete.","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/chapters/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/chapters/{tenantId}/{id}","href":"chapters/deletechapter","openApiOperationId":"deleteChapter","summary":"Returns a chapter from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to delete chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/deletechapter"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/{id}"},{"label":"Returns a chapter from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/getchapter","routeSlug":"/apis/membership/membership-v1/chapters/getchapter","metadata":{"seo":{"title":"Returns a chapter from the system by its ID.","description":"This method will look up a chapter by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChapter","name":"Returns a chapter from the system by its ID.","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter to return.","required":true}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/chapters/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/chapters/{tenantId}/{id}","href":"chapters/getchapter","openApiOperationId":"getChapter","summary":"Returns a chapter from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 chapter was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}},"schemaId":"components/schemas/Chapter","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Chapter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/getchapter"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/{id}"},{"label":"Partially updates a chapter with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/patchchapter","routeSlug":"/apis/membership/membership-v1/chapters/patchchapter","metadata":{"seo":{"title":"Partially updates a chapter with the specified ID.","description":"This method will patch an existing chapter with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchChapter","name":"Partially updates a chapter with the specified ID.","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter to patch.","required":true}],"pointer":"/paths/~1chapters~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1chapters~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":"/chapters/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapters/{tenantId}/{id}","href":"chapters/patchchapter","openApiOperationId":"patchChapter","summary":"Partially updates a chapter with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}},"schemaId":"components/schemas/Chapter","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Chapter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/patchchapter"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/{id}"},{"label":"Updates a chapter with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechapter","routeSlug":"/apis/membership/membership-v1/chapters/updatechapter","metadata":{"seo":{"title":"Updates a chapter with the specified ID.","description":"This method will update an existing chapter with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateChapter","name":"Updates a chapter with the specified ID.","isWebhook":false,"pointer":"/paths/~1chapters~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a chapter 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 chapter 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the chapter to update.","required":true}],"pointer":"/paths/~1chapters~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/Chapter"}},"schemaId":"components/schemas/Chapter","pointer":"/paths/~1chapters~1{tenantId}~1{id}/put/requestBody","description":"The updated chapter that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/chapters/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Chapter"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/chapters/{tenantId}/{id}","href":"chapters/updatechapter","openApiOperationId":"updateChapter","summary":"Updates a chapter with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Chapter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Chapter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The chapter was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}},"schemaId":"components/schemas/Chapter","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The chapter 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The chapter could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The chapter 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve chapter based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1chapters~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Chapter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Chapter"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/chapters/updatechapter"}],"panels":[]}]},"httpPath":"/chapters/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Chapters"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Chapters","showPageActions":true},{"nodeType":"markdoc","content":"Chapters"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/chapters/{tenantId}","summary":"Gets all of the chapters in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/listchapters","deprecated":false},{"title":"/chapters/{tenantId}","summary":"Creates a new chapter record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/createchapter","deprecated":false},{"title":"/chapters/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/executebatchoperations","deprecated":false},{"title":"/chapters/{tenantId}/committee/{chapterId}/{committeeId}","summary":"Change chapter committee terms","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/chapters/patchchaptercommittee","deprecated":false},{"title":"/chapters/{tenantId}/committeeMembership/{chapterId}","summary":"Create a chapter committee membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/createchaptercommitteemembership","deprecated":false},{"title":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}","summary":"Delete a chapter committee membership","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chapters/deletechaptercommitteemembership","deprecated":false},{"title":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}","summary":"Update a chapter committee membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chapters/updatechaptercommitteemembership","deprecated":false},{"title":"/chapters/{tenantId}/contact/{chapterId}","summary":"Creates a new contact on behalf of a chapter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/createchaptermembercontact","deprecated":false},{"title":"/chapters/{tenantId}/contact/{chapterId}/{contactId}","summary":"Get chapter member contact info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/getchaptermembercontact","deprecated":false},{"title":"/chapters/{tenantId}/contact/{chapterId}/{contactId}","summary":"Update chapter member contact info","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chapters/updatechaptermembercontact","deprecated":false},{"title":"/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}","summary":"Generates an application for a contact or organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/generatechaptermembershipapplication","deprecated":false},{"title":"/chapters/{tenantId}/generateOrder/{chapterId}","summary":"Generates an order from a membership application","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/generatechaptermembershiporder","deprecated":false},{"title":"/chapters/{tenantId}/membership/{chapterId}/{membershipId}","summary":"Update chapter member membership info","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chapters/updatechaptermembermembership","deprecated":false},{"title":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}","summary":"Returns a list of chapters for a given membership package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/describechaptersformembershippackage","deprecated":false},{"title":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}/{memberType}/{contactOrOrganizationId}","summary":"Returns a list of chapters for a given membership package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/describechaptersformembershippackageandmember","deprecated":false},{"title":"/chapters/{tenantId}/portal/findNearest/{latitude}/{longitude}","summary":"Searches for the nearest chapters to the latitude and longitude supplied","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/findnearestchapter","deprecated":false},{"title":"/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}","summary":"Get eligible application processes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/geteligibleappprocesses","deprecated":false},{"title":"/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}","summary":"Get portal permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/getportalpermissions","deprecated":false},{"title":"/chapters/{tenantId}/query/{chapterId}/{savedQueryId}/{outputFormat}","summary":"Runs a saved query on behalf of a chapter","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/runchapterquery","deprecated":false},{"title":"/chapters/{tenantId}/roster/{chapterId}","summary":"View chapter roster","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/viewchapterroster","deprecated":false},{"title":"/chapters/{tenantId}/search","summary":"Searches for chapters using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/chapters/searchforchapters","deprecated":false},{"title":"/chapters/{tenantId}/{id}","summary":"Returns a chapter from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/chapters/deletechapter","deprecated":false},{"title":"/chapters/{tenantId}/{id}","summary":"Returns a chapter from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/chapters/getchapter","deprecated":false},{"title":"/chapters/{tenantId}/{id}","summary":"Partially updates a chapter with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/chapters/patchchapter","deprecated":false},{"title":"/chapters/{tenantId}/{id}","summary":"Updates a chapter with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/chapters/updatechapter","deprecated":false}]}]}]}]}},{"type":"group","label":"Coupons","link":"/apis/membership/membership-v1/coupons","routeSlug":"/apis/membership/membership-v1/coupons","items":[{"label":"Gets all of the coupons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/listcoupons","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_557"}},"schemaId":"schema_557","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1coupons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_557","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_557"}}},{"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/membership/membership-v1/coupons/createcoupon","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/coupons/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/coupons/deletecoupon","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1coupons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/coupons/getcoupon","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/coupons/patchcoupon","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/coupons/updatecoupon","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Directories","link":"/apis/membership/membership-v1/directories","routeSlug":"/apis/membership/membership-v1/directories","items":[{"label":"Gets all of the directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/listdirectories","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_558"}},"schemaId":"schema_558","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1directories~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_558","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_558"}}},{"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/membership/membership-v1/directories/createdirectory","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/getdirectoryentry","routeSlug":"/apis/membership/membership-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_539","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1directories~1{tenantId}~1public~1entry~1{id}~1{entryId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"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/membership/membership-v1/directories/searchpublicdirectory","routeSlug":"/apis/membership/membership-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_539","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/senddirectorymessage","routeSlug":"/apis/membership/membership-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_539","description":"Parameters to the query","required":true},{"name":"directoryId","in":"path","schemaId":"schema_539","description":"directory","required":true},{"name":"entryId","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"directoryId","in":"path","required":true,"schemaId":"schema_539"},{"name":"entryId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_549"}},"schemaId":"schema_549","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1directories~1{tenantId}~1public~1sendMessage~1{directoryId}~1{entryId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_549","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_549"}}},{"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/membership/membership-v1/directories/getpublicdirectory","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/searchdirectory","routeSlug":"/apis/membership/membership-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_539","description":"Parameters to the query","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/deletedirectory","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1directories~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/directories/getdirectory","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/patchdirectory","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/directories/updatedirectory","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Elections","link":"/apis/membership/membership-v1/elections","routeSlug":"/apis/membership/membership-v1/elections","items":[{"label":"Creates a new election record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/createelection","routeSlug":"/apis/membership/membership-v1/elections/createelection","metadata":{"seo":{"title":"Creates a new election record that does not already exist.","description":"This method will auto-generate an ID and create a new election. If an ID is specified for the election, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createElection","name":"Creates a new election record that does not already exist.","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new election 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 election. If an ID is specified for the election, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1elections~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/Election"}},"schemaId":"components/schemas/Election","pointer":"/paths/~1elections~1{tenantId}/post/requestBody","description":"The election that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/elections/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Election"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/elections/{tenantId}","href":"elections/createelection","openApiOperationId":"createElection","summary":"Creates a new election record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Election","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Election"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The election was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}},"schemaId":"components/schemas/Election","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The election 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The election 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_541"},{"code":"429","description":"Limit exceeded... unable to add election based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Election","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/createelection"}],"panels":[]}]},"httpPath":"/elections/{tenantId}"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/listelectionsbychapterid","routeSlug":"/apis/membership/membership-v1/elections/listelectionsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listElectionsByChapterId","name":"Returns a list of records with the specified chapter_id","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1chapter~1{chapter_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified chapter_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 chapter_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_539","description":"The tenant","required":true},{"name":"chapter_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chapter_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1elections~1{tenantId}~1chapter~1{chapter_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1elections~1{tenantId}~1chapter~1{chapter_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/elections/{tenantId}/chapter/{chapter_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapter_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/elections/{tenantId}/chapter/{chapter_id}","href":"elections/listelectionsbychapterid","openApiOperationId":"listElectionsByChapterId","summary":"Returns a list of records with the specified chapter_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListElectionsResponse"}},"schemaId":"components/schemas/ListElectionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1chapter~1{chapter_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListElectionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListElectionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/listelectionsbychapterid"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/chapter/{chapter_id}"},{"label":"Returns a list of records with the specified committee_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/listelectionsbycommitteeid","routeSlug":"/apis/membership/membership-v1/elections/listelectionsbycommitteeid","metadata":{"seo":{"title":"Returns a list of records with the specified committee_id","description":"Returns a list of records with the specified committee_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listElectionsByCommitteeId","name":"Returns a list of records with the specified committee_id","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1committee~1{committee_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified committee_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 committee_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_539","description":"The tenant","required":true},{"name":"committee_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The committee_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1elections~1{tenantId}~1committee~1{committee_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1elections~1{tenantId}~1committee~1{committee_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/elections/{tenantId}/committee/{committee_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"committee_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/elections/{tenantId}/committee/{committee_id}","href":"elections/listelectionsbycommitteeid","openApiOperationId":"listElectionsByCommitteeId","summary":"Returns a list of records with the specified committee_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListElectionsResponse"}},"schemaId":"components/schemas/ListElectionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1committee~1{committee_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListElectionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListElectionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/listelectionsbycommitteeid"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/committee/{committee_id}"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/listelectionsbysectionid","routeSlug":"/apis/membership/membership-v1/elections/listelectionsbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listElectionsBySectionId","name":"Returns a list of records with the specified section_id","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1section~1{section_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified section_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 section_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_539","description":"The tenant","required":true},{"name":"section_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The section_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1elections~1{tenantId}~1section~1{section_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1elections~1{tenantId}~1section~1{section_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/elections/{tenantId}/section/{section_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"section_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/elections/{tenantId}/section/{section_id}","href":"elections/listelectionsbysectionid","openApiOperationId":"listElectionsBySectionId","summary":"Returns a list of records with the specified section_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListElectionsResponse"}},"schemaId":"components/schemas/ListElectionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1section~1{section_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListElectionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListElectionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/listelectionsbysectionid"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/section/{section_id}"},{"label":"Returns a election from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/deleteelection","routeSlug":"/apis/membership/membership-v1/elections/deleteelection","metadata":{"seo":{"title":"Returns a election from the system by its ID.","description":"This method will delete a election with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteElection","name":"Returns a election from the system by its ID.","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a election 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 election 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the election to delete.","required":true}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/elections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/elections/{tenantId}/{id}","href":"elections/deleteelection","openApiOperationId":"deleteElection","summary":"Returns a election from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 election was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The election could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The election 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_541"},{"code":"429","description":"Limit exceeded... unable to delete election based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/deleteelection"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/{id}"},{"label":"Returns a election from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/getelection","routeSlug":"/apis/membership/membership-v1/elections/getelection","metadata":{"seo":{"title":"Returns a election from the system by its ID.","description":"This method will look up a election by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getElection","name":"Returns a election from the system by its ID.","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a election 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 election 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the election to return.","required":true}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/elections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/elections/{tenantId}/{id}","href":"elections/getelection","openApiOperationId":"getElection","summary":"Returns a election from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 election was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}},"schemaId":"components/schemas/Election","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The election could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve election based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Election","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/getelection"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/{id}"},{"label":"Partially updates a election with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/patchelection","routeSlug":"/apis/membership/membership-v1/elections/patchelection","metadata":{"seo":{"title":"Partially updates a election with the specified ID.","description":"This method will patch an existing election with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchElection","name":"Partially updates a election with the specified ID.","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a election 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 election 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the election to patch.","required":true}],"pointer":"/paths/~1elections~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1elections~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":"/elections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/elections/{tenantId}/{id}","href":"elections/patchelection","openApiOperationId":"patchElection","summary":"Partially updates a election with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The election was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}},"schemaId":"components/schemas/Election","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The election could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The election 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve election based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Election","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/patchelection"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/{id}"},{"label":"Updates a election with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/updateelection","routeSlug":"/apis/membership/membership-v1/elections/updateelection","metadata":{"seo":{"title":"Updates a election with the specified ID.","description":"This method will update an existing election with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateElection","name":"Updates a election with the specified ID.","isWebhook":false,"pointer":"/paths/~1elections~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a election 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 election 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the election to update.","required":true}],"pointer":"/paths/~1elections~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/Election"}},"schemaId":"components/schemas/Election","pointer":"/paths/~1elections~1{tenantId}~1{id}/put/requestBody","description":"The updated election that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/elections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Election"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/elections/{tenantId}/{id}","href":"elections/updateelection","openApiOperationId":"updateElection","summary":"Updates a election with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Election","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Election"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The election was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}},"schemaId":"components/schemas/Election","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The election 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The election could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The election 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve election based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1elections~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Election","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Election"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/elections/updateelection"}],"panels":[]}]},"httpPath":"/elections/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Elections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Elections","showPageActions":true},{"nodeType":"markdoc","content":"Elections"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/elections/{tenantId}","summary":"Creates a new election record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/elections/createelection","deprecated":false},{"title":"/elections/{tenantId}/chapter/{chapter_id}","summary":"Returns a list of records with the specified chapter_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/elections/listelectionsbychapterid","deprecated":false},{"title":"/elections/{tenantId}/committee/{committee_id}","summary":"Returns a list of records with the specified committee_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/elections/listelectionsbycommitteeid","deprecated":false},{"title":"/elections/{tenantId}/section/{section_id}","summary":"Returns a list of records with the specified section_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/elections/listelectionsbysectionid","deprecated":false},{"title":"/elections/{tenantId}/{id}","summary":"Returns a election from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/elections/deleteelection","deprecated":false},{"title":"/elections/{tenantId}/{id}","summary":"Returns a election from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/elections/getelection","deprecated":false},{"title":"/elections/{tenantId}/{id}","summary":"Partially updates a election with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/elections/patchelection","deprecated":false},{"title":"/elections/{tenantId}/{id}","summary":"Updates a election with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/elections/updateelection","deprecated":false}]}]}]}]}},{"type":"group","label":"Group Application Processes","link":"/apis/membership/membership-v1/group-application-processes","routeSlug":"/apis/membership/membership-v1/group-application-processes","items":[{"label":"Gets all of the group application processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/listgroupapplicationprocesses","routeSlug":"/apis/membership/membership-v1/group-application-processes/listgroupapplicationprocesses","metadata":{"seo":{"title":"Gets all of the group application processes in the system.","description":"This method will scan all group application processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupApplicationProcesses","name":"Gets all of the group application processes in the system.","isWebhook":false,"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the group 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 group 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/groupApplicationProcesses/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/groupApplicationProcesses/{tenantId}","href":"group-application-processes/listgroupapplicationprocesses","openApiOperationId":"listGroupApplicationProcesses","summary":"Gets all of the group application processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 group application processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}},"schemaId":"schema_559","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/listgroupapplicationprocesses"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}"},{"label":"Creates a new group application process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/creategroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/creategroupapplicationprocess","metadata":{"seo":{"title":"Creates a new group application process record that does not already exist.","description":"This method will auto-generate an ID and create a new group application process. If an ID is specified for the group application process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGroupApplicationProcess","name":"Creates a new group application process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new group 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 group application process. If an ID is specified for the group 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~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/GroupApplicationProcess"}},"schemaId":"components/schemas/GroupApplicationProcess","pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/post/requestBody","description":"The group application process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/groupApplicationProcesses/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/groupApplicationProcesses/{tenantId}","href":"group-application-processes/creategroupapplicationprocess","openApiOperationId":"createGroupApplicationProcess","summary":"Creates a new group application process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GroupApplicationProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The group application process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"schemaId":"components/schemas/GroupApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The group 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The group 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_541"},{"code":"429","description":"Limit exceeded... unable to add group 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/creategroupapplicationprocess"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/executebatchoperations","routeSlug":"/apis/membership/membership-v1/group-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/~1groupApplicationProcesses~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~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/~1groupApplicationProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/groupApplicationProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/groupApplicationProcesses/{tenantId}/batch","href":"group-application-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The group 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve group 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~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":"/group-application-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{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/membership/membership-v1/group-application-processes/geteligibleprocesses","routeSlug":"/apis/membership/membership-v1/group-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/~1groupApplicationProcesses~1{tenantId}~1eligible~1{contactId}/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_539","description":"The id of the tenant being accessed","required":true},{"name":"contactId","in":"path","schemaId":"schema_539","description":"The contact id","required":true}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1eligible~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/groupApplicationProcesses/{tenantId}/eligible/{contactId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/groupApplicationProcesses/{tenantId}/eligible/{contactId}","href":"group-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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_559"}},"schemaId":"schema_559","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1eligible~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_559","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_559"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/geteligibleprocesses"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}/eligible/{contactId}"},{"label":"Returns a group application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/deletegroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/deletegroupapplicationprocess","metadata":{"seo":{"title":"Returns a group application process from the system by its ID.","description":"This method will delete a group application process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGroupApplicationProcess","name":"Returns a group application process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a group 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 group 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the group application process to delete.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/groupApplicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/groupApplicationProcesses/{tenantId}/{id}","href":"group-application-processes/deletegroupapplicationprocess","openApiOperationId":"deleteGroupApplicationProcess","summary":"Returns a group application process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 group application process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The group 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_541"},{"code":"409","description":"The group 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_541"},{"code":"429","description":"Limit exceeded... unable to delete group 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/deletegroupapplicationprocess"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"},{"label":"Returns a group application process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/getgroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/getgroupapplicationprocess","metadata":{"seo":{"title":"Returns a group application process from the system by its ID.","description":"This method will look up a group application process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroupApplicationProcess","name":"Returns a group application process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a group 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 group 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the group application process to return.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/groupApplicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/groupApplicationProcesses/{tenantId}/{id}","href":"group-application-processes/getgroupapplicationprocess","openApiOperationId":"getGroupApplicationProcess","summary":"Returns a group application process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 group application process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"schemaId":"components/schemas/GroupApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The group 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve group 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/getgroupapplicationprocess"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"},{"label":"Partially updates a group application process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/patchgroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/patchgroupapplicationprocess","metadata":{"seo":{"title":"Partially updates a group application process with the specified ID.","description":"This method will patch an existing group application process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGroupApplicationProcess","name":"Partially updates a group application process with the specified ID.","isWebhook":false,"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a group 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 group 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the group application process to patch.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1groupApplicationProcesses~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":"/groupApplicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/groupApplicationProcesses/{tenantId}/{id}","href":"group-application-processes/patchgroupapplicationprocess","openApiOperationId":"patchGroupApplicationProcess","summary":"Partially updates a group application process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The group application process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"schemaId":"components/schemas/GroupApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The group 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_541"},{"code":"409","description":"The group 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve group 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/patchgroupapplicationprocess"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"},{"label":"Updates a group application process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/updategroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/updategroupapplicationprocess","metadata":{"seo":{"title":"Updates a group application process with the specified ID.","description":"This method will update an existing group application process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGroupApplicationProcess","name":"Updates a group application process with the specified ID.","isWebhook":false,"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a group 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 group 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the group application process to update.","required":true}],"pointer":"/paths/~1groupApplicationProcesses~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/GroupApplicationProcess"}},"schemaId":"components/schemas/GroupApplicationProcess","pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated group application process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/groupApplicationProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/groupApplicationProcesses/{tenantId}/{id}","href":"group-application-processes/updategroupapplicationprocess","openApiOperationId":"updateGroupApplicationProcess","summary":"Updates a group application process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GroupApplicationProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The group application process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}},"schemaId":"components/schemas/GroupApplicationProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The group 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The group 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_541"},{"code":"409","description":"The group 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve group 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1groupApplicationProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GroupApplicationProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GroupApplicationProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-application-processes/updategroupapplicationprocess"}],"panels":[]}]},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Group Application Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group Application Processes","showPageActions":true},{"nodeType":"markdoc","content":"Group Application Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/groupApplicationProcesses/{tenantId}","summary":"Gets all of the group application processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group-application-processes/listgroupapplicationprocesses","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}","summary":"Creates a new group application process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group-application-processes/creategroupapplicationprocess","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group-application-processes/executebatchoperations","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}/eligible/{contactId}","summary":"Gets all of the processes a contact is eligible to use","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group-application-processes/geteligibleprocesses","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}/{id}","summary":"Returns a group application process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/group-application-processes/deletegroupapplicationprocess","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}/{id}","summary":"Returns a group application process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group-application-processes/getgroupapplicationprocess","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}/{id}","summary":"Partially updates a group application process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/group-application-processes/patchgroupapplicationprocess","deprecated":false},{"title":"/groupApplicationProcesses/{tenantId}/{id}","summary":"Updates a group application process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/group-application-processes/updategroupapplicationprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Id Card Templates","link":"/apis/membership/membership-v1/id-card-templates","routeSlug":"/apis/membership/membership-v1/id-card-templates","items":[{"label":"Gets all of the id card templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/listidcardtemplates","routeSlug":"/apis/membership/membership-v1/id-card-templates/listidcardtemplates","metadata":{"seo":{"title":"Gets all of the id card templates in the system.","description":"This method will scan all id card templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIdCardTemplates","name":"Gets all of the id card templates in the system.","isWebhook":false,"pointer":"/paths/~1idCardTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the id card 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 id card 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1idCardTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idCardTemplates/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/idCardTemplates/{tenantId}","href":"id-card-templates/listidcardtemplates","openApiOperationId":"listIdCardTemplates","summary":"Gets all of the id card templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 id card templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}},"schemaId":"schema_560","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_560","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_560"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/id-card-templates/listidcardtemplates"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}"},{"label":"Creates a new id card template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/createidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/createidcardtemplate","metadata":{"seo":{"title":"Creates a new id card template record that does not already exist.","description":"This method will auto-generate an ID and create a new id card template. If an ID is specified for the id card template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createIdCardTemplate","name":"Creates a new id card template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1idCardTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new id card 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 id card template. If an ID is specified for the id card 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1idCardTemplates~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/IdCardTemplate"}},"schemaId":"components/schemas/IdCardTemplate","pointer":"/paths/~1idCardTemplates~1{tenantId}/post/requestBody","description":"The id card template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idCardTemplates/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/idCardTemplates/{tenantId}","href":"id-card-templates/createidcardtemplate","openApiOperationId":"createIdCardTemplate","summary":"Creates a new id card template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/IdCardTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The id card template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"schemaId":"components/schemas/IdCardTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The id card 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The id card 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_541"},{"code":"429","description":"Limit exceeded... unable to add id card 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdCardTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/id-card-templates/createidcardtemplate"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/executebatchoperations","routeSlug":"/apis/membership/membership-v1/id-card-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/~1idCardTemplates~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1idCardTemplates~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/~1idCardTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/idCardTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/idCardTemplates/{tenantId}/batch","href":"id-card-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The id card 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve id card 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~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":"/id-card-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}/batch"},{"label":"Returns a id card template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/deleteidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/deleteidcardtemplate","metadata":{"seo":{"title":"Returns a id card template from the system by its ID.","description":"This method will delete a id card template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteIdCardTemplate","name":"Returns a id card template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a id card 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 id card 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the id card template to delete.","required":true}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/idCardTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/idCardTemplates/{tenantId}/{id}","href":"id-card-templates/deleteidcardtemplate","openApiOperationId":"deleteIdCardTemplate","summary":"Returns a id card template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 id card template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The id card 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_541"},{"code":"409","description":"The id card 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_541"},{"code":"429","description":"Limit exceeded... unable to delete id card 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/id-card-templates/deleteidcardtemplate"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}/{id}"},{"label":"Returns a id card template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/getidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/getidcardtemplate","metadata":{"seo":{"title":"Returns a id card template from the system by its ID.","description":"This method will look up a id card template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdCardTemplate","name":"Returns a id card template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a id card 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 id card 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the id card template to return.","required":true}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/idCardTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/idCardTemplates/{tenantId}/{id}","href":"id-card-templates/getidcardtemplate","openApiOperationId":"getIdCardTemplate","summary":"Returns a id card template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 id card template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"schemaId":"components/schemas/IdCardTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The id card 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve id card 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdCardTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/id-card-templates/getidcardtemplate"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}/{id}"},{"label":"Partially updates a id card template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/patchidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/patchidcardtemplate","metadata":{"seo":{"title":"Partially updates a id card template with the specified ID.","description":"This method will patch an existing id card template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchIdCardTemplate","name":"Partially updates a id card template with the specified ID.","isWebhook":false,"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a id card 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 id card 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the id card template to patch.","required":true}],"pointer":"/paths/~1idCardTemplates~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1idCardTemplates~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":"/idCardTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/idCardTemplates/{tenantId}/{id}","href":"id-card-templates/patchidcardtemplate","openApiOperationId":"patchIdCardTemplate","summary":"Partially updates a id card template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The id card template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"schemaId":"components/schemas/IdCardTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The id card 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_541"},{"code":"409","description":"The id card 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve id card 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdCardTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/id-card-templates/patchidcardtemplate"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}/{id}"},{"label":"Updates a id card template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/updateidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/updateidcardtemplate","metadata":{"seo":{"title":"Updates a id card template with the specified ID.","description":"This method will update an existing id card template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateIdCardTemplate","name":"Updates a id card template with the specified ID.","isWebhook":false,"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a id card 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 id card 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the id card template to update.","required":true}],"pointer":"/paths/~1idCardTemplates~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/IdCardTemplate"}},"schemaId":"components/schemas/IdCardTemplate","pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated id card template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/idCardTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/idCardTemplates/{tenantId}/{id}","href":"id-card-templates/updateidcardtemplate","openApiOperationId":"updateIdCardTemplate","summary":"Updates a id card template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/IdCardTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The id card template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}},"schemaId":"components/schemas/IdCardTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The id card 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The id card 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_541"},{"code":"409","description":"The id card 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve id card 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1idCardTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdCardTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdCardTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/id-card-templates/updateidcardtemplate"}],"panels":[]}]},"httpPath":"/idCardTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Id Card Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Id Card Templates","showPageActions":true},{"nodeType":"markdoc","content":"Id Card Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/idCardTemplates/{tenantId}","summary":"Gets all of the id card templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/id-card-templates/listidcardtemplates","deprecated":false},{"title":"/idCardTemplates/{tenantId}","summary":"Creates a new id card template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/id-card-templates/createidcardtemplate","deprecated":false},{"title":"/idCardTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/id-card-templates/executebatchoperations","deprecated":false},{"title":"/idCardTemplates/{tenantId}/{id}","summary":"Returns a id card template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/id-card-templates/deleteidcardtemplate","deprecated":false},{"title":"/idCardTemplates/{tenantId}/{id}","summary":"Returns a id card template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/id-card-templates/getidcardtemplate","deprecated":false},{"title":"/idCardTemplates/{tenantId}/{id}","summary":"Partially updates a id card template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/id-card-templates/patchidcardtemplate","deprecated":false},{"title":"/idCardTemplates/{tenantId}/{id}","summary":"Updates a id card template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/id-card-templates/updateidcardtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Memberships","link":"/apis/membership/membership-v1/memberships","routeSlug":"/apis/membership/membership-v1/memberships","items":[{"label":"Creates a new membership record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/createmembership","routeSlug":"/apis/membership/membership-v1/memberships/createmembership","metadata":{"seo":{"title":"Creates a new membership record that does not already exist.","description":"This method will auto-generate an ID and create a new membership. If an ID is specified for the membership, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMembership","name":"Creates a new membership record that does not already exist.","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new membership 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 membership. If an ID is specified for the membership, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1memberships~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/Membership"}},"schemaId":"components/schemas/Membership","pointer":"/paths/~1memberships~1{tenantId}/post/requestBody","description":"The membership that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Membership"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/memberships/{tenantId}","href":"memberships/createmembership","openApiOperationId":"createMembership","summary":"Creates a new membership record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Membership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The membership was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The membership 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The membership 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_541"},{"code":"429","description":"Limit exceeded... unable to add membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/createmembership"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}"},{"label":"Activate membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/activatemembership","routeSlug":"/apis/membership/membership-v1/memberships/activatemembership","metadata":{"seo":{"title":"Activate membership","description":"Activate membership"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateMembership","name":"Activate membership","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1activate~1{application_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Activate membership"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The id of the tenant being accessed.","required":true},{"name":"application_id","in":"path","schemaId":"schema_539","description":"The contact id","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1activate~1{application_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}/activate/{application_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"application_id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/activate/{application_id}","href":"memberships/activatemembership","openApiOperationId":"activateMembership","summary":"Activate membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1activate~1{application_id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/activatemembership"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/activate/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/executebatchoperations","routeSlug":"/apis/membership/membership-v1/memberships/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/~1memberships~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1memberships~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/~1memberships~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/batch","href":"memberships/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The membership could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~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":"/memberships/executebatchoperations"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/batch"},{"label":"Downloads a Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/downloadcertificate","routeSlug":"/apis/membership/membership-v1/memberships/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/~1memberships~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_539","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1certificate~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"downloadAsHtml","in":"query","schemaId":"schema_561","description":"If true, return the receipt as HTML"}],"pointer":"/paths/~1memberships~1{tenantId}~1certificate~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/certificate/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"downloadAsHtml","in":"query","required":false,"schemaId":"schema_561"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/certificate/{id}","href":"memberships/downloadcertificate","openApiOperationId":"downloadCertificate","summary":"Downloads a Certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 membership was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1certificate~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/downloadcertificate"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/certificate/{id}"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbychapterid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMembershipsByChapterId","name":"Returns a list of records with the specified chapter_id","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1chapter~1{chapter_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified chapter_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 chapter_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_539","description":"The tenant","required":true},{"name":"chapter_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The chapter_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1chapter~1{chapter_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"chapterStatus","in":"query","schemaId":"schema_562","description":"Filter by chaper status"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1memberships~1{tenantId}~1chapter~1{chapter_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/chapter/{chapter_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"chapter_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"chapterStatus","in":"query","required":false,"schemaId":"schema_562"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/chapter/{chapter_id}","href":"memberships/listmembershipsbychapterid","openApiOperationId":"listMembershipsByChapterId","summary":"Returns a list of records with the specified chapter_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListMembershipsResponse"}},"schemaId":"components/schemas/ListMembershipsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1chapter~1{chapter_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMembershipsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMembershipsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listmembershipsbychapterid"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/chapter/{chapter_id}"},{"label":"Gets a membership by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembershipforcontact","routeSlug":"/apis/membership/membership-v1/memberships/getmembershipforcontact","metadata":{"seo":{"title":"Gets a membership by contact","description":"Gets a membership by contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMembershipForContact","name":"Gets a membership by contact","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1contact~1{contactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a membership by contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a membership 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"contactId","in":"path","schemaId":"schema_539","description":"The contact id","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1contact~1{contactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/contact/{contactId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/contact/{contactId}","href":"memberships/getmembershipforcontact","openApiOperationId":"getMembershipForContact","summary":"Gets a membership by contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1contact~1{contactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/getmembershipforcontact"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/contact/{contactId}"},{"label":"Given a set of expiration options, allows for the calculation of an expiration date","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/calculateexpirationdate","routeSlug":"/apis/membership/membership-v1/memberships/calculateexpirationdate","metadata":{"seo":{"title":"Given a set of expiration options, allows for the calculation of an expiration date","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calculateExpirationDate","name":"Given a set of expiration options, allows for the calculation of an expiration date","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1expirationDateCalculation~1{dateToUseAsBasisForCalculation}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Given a set of expiration options, allows for the calculation of an expiration date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Given a set of expiration options, allows for the calculation of an expiration date"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The id of the tenant being accessed.","required":true},{"name":"dateToUseAsBasisForCalculation","in":"path","schemaId":"schema_539","description":"The date that should be used as the basis for calculation","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1expirationDateCalculation~1{dateToUseAsBasisForCalculation}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","pointer":"/paths/~1memberships~1{tenantId}~1expirationDateCalculation~1{dateToUseAsBasisForCalculation}/post/requestBody","description":"The expiration options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}/expirationDateCalculation/{dateToUseAsBasisForCalculation}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"dateToUseAsBasisForCalculation","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Membership"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/expirationDateCalculation/{dateToUseAsBasisForCalculation}","href":"memberships/calculateexpirationdate","openApiOperationId":"calculateExpirationDate","summary":"Given a set of expiration options, allows for the calculation of an expiration date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Membership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Date was calculated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1expirationDateCalculation~1{dateToUseAsBasisForCalculation}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/calculateexpirationdate"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/expirationDateCalculation/{dateToUseAsBasisForCalculation}"},{"label":"Generates a PDF for the ID Card and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/downloadidcard","routeSlug":"/apis/membership/membership-v1/memberships/downloadidcard","metadata":{"seo":{"title":"Generates a PDF for the ID Card and returns the public link for download","description":"Generates a PDF for the ID Card and returns the public link for download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadIdCard","name":"Generates a PDF for the ID Card and returns the public link for download","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1idCard~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a PDF for the ID Card and returns the public link for download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a PDF for the ID Card and returns the public link for download"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1idCard~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"downloadAsHtml","in":"query","schemaId":"schema_561","description":"If true, return the receipt as HTML"}],"pointer":"/paths/~1memberships~1{tenantId}~1idCard~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/idCard/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"downloadAsHtml","in":"query","required":false,"schemaId":"schema_561"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/idCard/{id}","href":"memberships/downloadidcard","openApiOperationId":"downloadIdCard","summary":"Generates a PDF for the ID Card and returns the public link for download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 membership was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1idCard~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/downloadidcard"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/idCard/{id}"},{"label":"Generates snapshot lookback for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/initiatesnapshotlookback","routeSlug":"/apis/membership/membership-v1/memberships/initiatesnapshotlookback","metadata":{"seo":{"title":"Generates snapshot lookback for a tenant","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiateSnapshotLookback","name":"Generates snapshot lookback for a tenant","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1initiateSnapshotLookback/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates snapshot lookback for a tenant","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Given a set of expiration options, allows for the calculation of an expiration date"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1initiateSnapshotLookback/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}/initiateSnapshotLookback","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/initiateSnapshotLookback","href":"memberships/initiatesnapshotlookback","openApiOperationId":"initiateSnapshotLookback","summary":"Generates snapshot lookback for a tenant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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":"Date was calculated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1initiateSnapshotLookback/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/initiatesnapshotlookback"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/initiateSnapshotLookback"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbyorderid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbyorderid","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":"listMembershipsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1memberships~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_539","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_539","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/~1memberships~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1memberships~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/order/{order_id}","href":"memberships/listmembershipsbyorderid","openApiOperationId":"listMembershipsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListMembershipsResponse"}},"schemaId":"components/schemas/ListMembershipsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMembershipsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMembershipsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listmembershipsbyorderid"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/order/{order_id}"},{"label":"Gets a membership by organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembershipfororganization","routeSlug":"/apis/membership/membership-v1/memberships/getmembershipfororganization","metadata":{"seo":{"title":"Gets a membership by organization","description":"Gets a membership by organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMembershipForOrganization","name":"Gets a membership by organization","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1organization~1{organizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets a membership by organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a membership by organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The id of the tenant being accessed.","required":true},{"name":"organizationId","in":"path","schemaId":"schema_539","description":"The organization id","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1organization~1{organizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/organization/{organizationId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"organizationId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/organization/{organizationId}","href":"memberships/getmembershipfororganization","openApiOperationId":"getMembershipForOrganization","summary":"Gets a membership by organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1organization~1{organizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/getmembershipfororganization"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/organization/{organizationId}"},{"label":"Returns a list of records with the specified parent_membership_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbyparentmembershipid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbyparentmembershipid","metadata":{"seo":{"title":"Returns a list of records with the specified parent_membership_id","description":"Returns a list of records with the specified parent_membership_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMembershipsByParentMembershipId","name":"Returns a list of records with the specified parent_membership_id","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1parentMembership~1{parent_membership_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified parent_membership_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 parent_membership_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_539","description":"The tenant","required":true},{"name":"parent_membership_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parent_membership_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1parentMembership~1{parent_membership_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1memberships~1{tenantId}~1parentMembership~1{parent_membership_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/parentMembership/{parent_membership_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"parent_membership_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/parentMembership/{parent_membership_id}","href":"memberships/listmembershipsbyparentmembershipid","openApiOperationId":"listMembershipsByParentMembershipId","summary":"Returns a list of records with the specified parent_membership_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListMembershipsResponse"}},"schemaId":"components/schemas/ListMembershipsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1parentMembership~1{parent_membership_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMembershipsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMembershipsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listmembershipsbyparentmembershipid"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/parentMembership/{parent_membership_id}"},{"label":"Returns a membership from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembershipforportal","routeSlug":"/apis/membership/membership-v1/memberships/getmembershipforportal","metadata":{"seo":{"title":"Returns a membership from the system by its ID for a given contact.","description":"This method will look up a membership by the specified ID and return it back (for a portal contact)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMembershipForPortal","name":"Returns a membership from the system by its ID for a given contact.","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a membership from the system by its ID for a given contact.","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 membership by the specified ID and return it back (for a portal 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_539","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership to return.","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1memberships~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/portal/contact/{portalContactId}/{id}","href":"memberships/getmembershipforportal","openApiOperationId":"getMembershipForPortal","summary":"Returns a membership from the system by its ID for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 membership was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The membership could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/getmembershipforportal"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Sends out a preview of the CRC notification certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewcertificate","routeSlug":"/apis/membership/membership-v1/memberships/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/~1memberships~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_539","description":"The tenant","required":true}],"pointer":"/paths/~1memberships~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/~1memberships~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":"/memberships/{tenantId}/previewCertificate","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/previewCertificate","href":"memberships/previewcertificate","openApiOperationId":"previewCertificate","summary":"Sends out a preview of the CRC notification certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1previewCertificate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/previewcertificate"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/previewCertificate"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewemail","routeSlug":"/apis/membership/membership-v1/memberships/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/~1memberships~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_539","description":"The tenant","required":true}],"pointer":"/paths/~1memberships~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/~1memberships~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":"/memberships/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/previewEmail","href":"memberships/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/previewemail"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/previewEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewgroupapplicationemail","routeSlug":"/apis/membership/membership-v1/memberships/previewgroupapplicationemail","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":"previewGroupApplicationEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1previewGroupApplicationEmail/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_539","description":"The tenant","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1previewGroupApplicationEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewGroupApplicationEmailRequest"}},"schemaId":"components/schemas/PreviewGroupApplicationEmailRequest","pointer":"/paths/~1memberships~1{tenantId}~1previewGroupApplicationEmail/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":"/memberships/{tenantId}/previewGroupApplicationEmail","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewGroupApplicationEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/previewGroupApplicationEmail","href":"memberships/previewgroupapplicationemail","openApiOperationId":"previewGroupApplicationEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewGroupApplicationEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewGroupApplicationEmailRequest"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1previewGroupApplicationEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/previewgroupapplicationemail"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/previewGroupApplicationEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewidcard","routeSlug":"/apis/membership/membership-v1/memberships/previewidcard","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":"previewIdCard","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1previewIdCard~1{id}/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_539","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The membership ID","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1previewIdCard~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/PreviewIdCardRequest"}},"schemaId":"components/schemas/PreviewIdCardRequest","pointer":"/paths/~1memberships~1{tenantId}~1previewIdCard~1{id}/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":"/memberships/{tenantId}/previewIdCard/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewIdCardRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/previewIdCard/{id}","href":"memberships/previewidcard","openApiOperationId":"previewIdCard","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewIdCardRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewIdCardRequest"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1previewIdCard~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/previewidcard"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/previewIdCard/{id}"},{"label":"Re-runs flowdown for all organizations in the system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/reprocessflowdown","routeSlug":"/apis/membership/membership-v1/memberships/reprocessflowdown","metadata":{"seo":{"title":"Re-runs flowdown for all organizations in the system","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reprocessFlowdown","name":"Re-runs flowdown for all organizations in the system","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1reprocessFlowDown/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Re-runs flowdown for all organizations in the system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Given a set of expiration options, allows for the calculation of an expiration date"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1reprocessFlowDown/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReprocessFlowdownRequest"}},"schemaId":"components/schemas/ReprocessFlowdownRequest","pointer":"/paths/~1memberships~1{tenantId}~1reprocessFlowDown/post/requestBody","description":"The id of the tenant being accessed."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}/reprocessFlowDown","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReprocessFlowdownRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/reprocessFlowDown","href":"memberships/reprocessflowdown","openApiOperationId":"reprocessFlowdown","summary":"Re-runs flowdown for all organizations in the system"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ReprocessFlowdownRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReprocessFlowdownRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Date was calculated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1reprocessFlowDown/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/reprocessflowdown"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/reprocessFlowDown"},{"label":"Searches for memberships using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/searchformemberships","routeSlug":"/apis/membership/membership-v1/memberships/searchformemberships","metadata":{"seo":{"title":"Searches for memberships using predefined parameters","description":"Searches for memberships using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForMemberships","name":"Searches for memberships using predefined parameters","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for memberships 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 memberships 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_539","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1memberships~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/MembershipSearchParameters"}},"schemaId":"components/schemas/MembershipSearchParameters","pointer":"/paths/~1memberships~1{tenantId}~1search/post/requestBody","description":"The membership that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/memberships/{tenantId}/search","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MembershipSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/memberships/{tenantId}/search","href":"memberships/searchformemberships","openApiOperationId":"searchForMemberships","summary":"Searches for memberships using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MembershipSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MembershipSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The membership search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedMembershipSearchResults"}},"schemaId":"components/schemas/PagedMembershipSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The membership 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The membership 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_541"},{"code":"429","description":"Limit exceeded... unable to add membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedMembershipSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedMembershipSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/searchformemberships"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/search"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbysectionid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMembershipsBySectionId","name":"Returns a list of records with the specified section_id","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1section~1{section_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified section_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 section_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_539","description":"The tenant","required":true},{"name":"section_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The section_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1section~1{section_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"sectionStatus","in":"query","schemaId":"schema_562","description":"Filter by chaper status"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1memberships~1{tenantId}~1section~1{section_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/section/{section_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"section_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"sectionStatus","in":"query","required":false,"schemaId":"schema_562"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/section/{section_id}","href":"memberships/listmembershipsbysectionid","openApiOperationId":"listMembershipsBySectionId","summary":"Returns a list of records with the specified section_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListMembershipsResponse"}},"schemaId":"components/schemas/ListMembershipsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1section~1{section_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListMembershipsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListMembershipsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/listmembershipsbysectionid"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/section/{section_id}"},{"label":"Returns a membership from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/deletemembership","routeSlug":"/apis/membership/membership-v1/memberships/deletemembership","metadata":{"seo":{"title":"Returns a membership from the system by its ID.","description":"This method will delete a membership with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMembership","name":"Returns a membership from the system by its ID.","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a membership 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 membership 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership to delete.","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/memberships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/memberships/{tenantId}/{id}","href":"memberships/deletemembership","openApiOperationId":"deleteMembership","summary":"Returns a membership from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 membership was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The membership could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The membership 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_541"},{"code":"429","description":"Limit exceeded... unable to delete membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/deletemembership"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Returns a membership from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembership","routeSlug":"/apis/membership/membership-v1/memberships/getmembership","metadata":{"seo":{"title":"Returns a membership from the system by its ID.","description":"This method will look up a membership by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMembership","name":"Returns a membership from the system by its ID.","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a membership 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 membership 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership to return.","required":true}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/memberships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/memberships/{tenantId}/{id}","href":"memberships/getmembership","openApiOperationId":"getMembership","summary":"Returns a membership from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 membership was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The membership could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/getmembership"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Partially updates a membership with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/patchmembership","routeSlug":"/apis/membership/membership-v1/memberships/patchmembership","metadata":{"seo":{"title":"Partially updates a membership with the specified ID.","description":"This method will patch an existing membership with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchMembership","name":"Partially updates a membership with the specified ID.","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a membership 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 membership 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership to patch.","required":true}],"pointer":"/paths/~1memberships~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1memberships~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":"/memberships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/memberships/{tenantId}/{id}","href":"memberships/patchmembership","openApiOperationId":"patchMembership","summary":"Partially updates a membership with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The membership was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The membership could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The membership 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/patchmembership"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Updates a membership with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/updatemembership","routeSlug":"/apis/membership/membership-v1/memberships/updatemembership","metadata":{"seo":{"title":"Updates a membership with the specified ID.","description":"This method will update an existing membership with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMembership","name":"Updates a membership with the specified ID.","isWebhook":false,"pointer":"/paths/~1memberships~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a membership 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 membership 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the membership to update.","required":true}],"pointer":"/paths/~1memberships~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/Membership"}},"schemaId":"components/schemas/Membership","pointer":"/paths/~1memberships~1{tenantId}~1{id}/put/requestBody","description":"The updated membership that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/memberships/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Membership"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/memberships/{tenantId}/{id}","href":"memberships/updatemembership","openApiOperationId":"updateMembership","summary":"Updates a membership with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Membership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The membership was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}},"schemaId":"components/schemas/Membership","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The membership 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The membership could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The membership 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve membership based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1memberships~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Membership","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Membership"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/memberships/updatemembership"}],"panels":[]}]},"httpPath":"/memberships/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Memberships"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Memberships","showPageActions":true},{"nodeType":"markdoc","content":"Memberships"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/memberships/{tenantId}","summary":"Creates a new membership record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/createmembership","deprecated":false},{"title":"/memberships/{tenantId}/activate/{application_id}","summary":"Activate membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/activatemembership","deprecated":false},{"title":"/memberships/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/executebatchoperations","deprecated":false},{"title":"/memberships/{tenantId}/certificate/{id}","summary":"Downloads a Certificate","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/downloadcertificate","deprecated":false},{"title":"/memberships/{tenantId}/chapter/{chapter_id}","summary":"Returns a list of records with the specified chapter_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listmembershipsbychapterid","deprecated":false},{"title":"/memberships/{tenantId}/contact/{contactId}","summary":"Gets a membership by contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/getmembershipforcontact","deprecated":false},{"title":"/memberships/{tenantId}/expirationDateCalculation/{dateToUseAsBasisForCalculation}","summary":"Given a set of expiration options, allows for the calculation of an expiration date","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/calculateexpirationdate","deprecated":false},{"title":"/memberships/{tenantId}/idCard/{id}","summary":"Generates a PDF for the ID Card and returns the public link for download","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/downloadidcard","deprecated":false},{"title":"/memberships/{tenantId}/initiateSnapshotLookback","summary":"Generates snapshot lookback for a tenant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/initiatesnapshotlookback","deprecated":false},{"title":"/memberships/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listmembershipsbyorderid","deprecated":false},{"title":"/memberships/{tenantId}/organization/{organizationId}","summary":"Gets a membership by organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/getmembershipfororganization","deprecated":false},{"title":"/memberships/{tenantId}/parentMembership/{parent_membership_id}","summary":"Returns a list of records with the specified parent_membership_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listmembershipsbyparentmembershipid","deprecated":false},{"title":"/memberships/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Returns a membership from the system by its ID for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/getmembershipforportal","deprecated":false},{"title":"/memberships/{tenantId}/previewCertificate","summary":"Sends out a preview of the CRC notification certificate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/previewcertificate","deprecated":false},{"title":"/memberships/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/previewemail","deprecated":false},{"title":"/memberships/{tenantId}/previewGroupApplicationEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/previewgroupapplicationemail","deprecated":false},{"title":"/memberships/{tenantId}/previewIdCard/{id}","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/previewidcard","deprecated":false},{"title":"/memberships/{tenantId}/reprocessFlowDown","summary":"Re-runs flowdown for all organizations in the system","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/reprocessflowdown","deprecated":false},{"title":"/memberships/{tenantId}/search","summary":"Searches for memberships using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/memberships/searchformemberships","deprecated":false},{"title":"/memberships/{tenantId}/section/{section_id}","summary":"Returns a list of records with the specified section_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/listmembershipsbysectionid","deprecated":false},{"title":"/memberships/{tenantId}/{id}","summary":"Returns a membership from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/memberships/deletemembership","deprecated":false},{"title":"/memberships/{tenantId}/{id}","summary":"Returns a membership from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/memberships/getmembership","deprecated":false},{"title":"/memberships/{tenantId}/{id}","summary":"Partially updates a membership with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/memberships/patchmembership","deprecated":false},{"title":"/memberships/{tenantId}/{id}","summary":"Updates a membership with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/memberships/updatemembership","deprecated":false}]}]}]}]}},{"type":"group","label":"Packages","link":"/apis/membership/membership-v1/packages","routeSlug":"/apis/membership/membership-v1/packages","items":[{"label":"Gets all of the packages in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/listpackages","routeSlug":"/apis/membership/membership-v1/packages/listpackages","metadata":{"seo":{"title":"Gets all of the packages in the system.","description":"This method will scan all packages and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPackages","name":"Gets all of the packages in the system.","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the packages 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 packages 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1packages~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1packages~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/packages/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/packages/{tenantId}","href":"packages/listpackages","openApiOperationId":"listPackages","summary":"Gets all of the packages in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 packageswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}},"schemaId":"schema_563","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_563","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_563"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/listpackages"}],"panels":[]}]},"httpPath":"/packages/{tenantId}"},{"label":"Creates a new package record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/createpackage","routeSlug":"/apis/membership/membership-v1/packages/createpackage","metadata":{"seo":{"title":"Creates a new package record that does not already exist.","description":"This method will auto-generate an ID and create a new package. If an ID is specified for the package, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPackage","name":"Creates a new package record that does not already exist.","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new package 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 package. If an ID is specified for the package, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1packages~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/Package"}},"schemaId":"components/schemas/Package","pointer":"/paths/~1packages~1{tenantId}/post/requestBody","description":"The package that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/packages/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Package"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/packages/{tenantId}","href":"packages/createpackage","openApiOperationId":"createPackage","summary":"Creates a new package record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Package"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The package was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}},"schemaId":"components/schemas/Package","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The package 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The package 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_541"},{"code":"429","description":"Limit exceeded... unable to add package based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/createpackage"}],"panels":[]}]},"httpPath":"/packages/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/executebatchoperations","routeSlug":"/apis/membership/membership-v1/packages/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/~1packages~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1packages~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/~1packages~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/packages/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/packages/{tenantId}/batch","href":"packages/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The package could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve package based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~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":"/packages/executebatchoperations"}],"panels":[]}]},"httpPath":"/packages/{tenantId}/batch"},{"label":"Get Packages for Online Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/getpackagesforonlinestore","routeSlug":"/apis/membership/membership-v1/packages/getpackagesforonlinestore","metadata":{"seo":{"title":"Get Packages for Online Store","description":"Public endpoint that gets packages for use in the online store"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackagesForOnlineStore","name":"Get Packages for Online Store","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}~1public~1onlineStore/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Packages 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 packages for use in the online store"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true}],"pointer":"/paths/~1packages~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/PublicMembershipPackagesRequest"}},"schemaId":"components/schemas/PublicMembershipPackagesRequest","pointer":"/paths/~1packages~1{tenantId}~1public~1onlineStore/post/requestBody","description":"Restrictions"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/packages/{tenantId}/public/onlineStore","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicMembershipPackagesRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/packages/{tenantId}/public/onlineStore","href":"packages/getpackagesforonlinestore","openApiOperationId":"getPackagesForOnlineStore","summary":"Get Packages for Online Store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PublicMembershipPackagesRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicMembershipPackagesRequest"}},"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/PublicMembershipPackagesResponse"}},"schemaId":"components/schemas/PublicMembershipPackagesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}~1public~1onlineStore/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublicMembershipPackagesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicMembershipPackagesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/getpackagesforonlinestore"}],"panels":[]}]},"httpPath":"/packages/{tenantId}/public/onlineStore"},{"label":"Returns a package from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/deletepackage","routeSlug":"/apis/membership/membership-v1/packages/deletepackage","metadata":{"seo":{"title":"Returns a package from the system by its ID.","description":"This method will delete a package with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePackage","name":"Returns a package from the system by its ID.","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a package 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 package 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the package to delete.","required":true}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/packages/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/packages/{tenantId}/{id}","href":"packages/deletepackage","openApiOperationId":"deletePackage","summary":"Returns a package from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 package was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The package could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The package 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_541"},{"code":"429","description":"Limit exceeded... unable to delete package based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/deletepackage"}],"panels":[]}]},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Returns a package from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/getpackage","routeSlug":"/apis/membership/membership-v1/packages/getpackage","metadata":{"seo":{"title":"Returns a package from the system by its ID.","description":"This method will look up a package by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPackage","name":"Returns a package from the system by its ID.","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a package 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 package 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the package to return.","required":true}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/packages/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/packages/{tenantId}/{id}","href":"packages/getpackage","openApiOperationId":"getPackage","summary":"Returns a package from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 package was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}},"schemaId":"components/schemas/Package","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The package could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve package based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/getpackage"}],"panels":[]}]},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Partially updates a package with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/patchpackage","routeSlug":"/apis/membership/membership-v1/packages/patchpackage","metadata":{"seo":{"title":"Partially updates a package with the specified ID.","description":"This method will patch an existing package with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPackage","name":"Partially updates a package with the specified ID.","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a package 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 package 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the package to patch.","required":true}],"pointer":"/paths/~1packages~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1packages~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":"/packages/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/packages/{tenantId}/{id}","href":"packages/patchpackage","openApiOperationId":"patchPackage","summary":"Partially updates a package with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The package was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}},"schemaId":"components/schemas/Package","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The package could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The package 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve package based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/patchpackage"}],"panels":[]}]},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Updates a package with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/updatepackage","routeSlug":"/apis/membership/membership-v1/packages/updatepackage","metadata":{"seo":{"title":"Updates a package with the specified ID.","description":"This method will update an existing package with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePackage","name":"Updates a package with the specified ID.","isWebhook":false,"pointer":"/paths/~1packages~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a package 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 package 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the package to update.","required":true}],"pointer":"/paths/~1packages~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/Package"}},"schemaId":"components/schemas/Package","pointer":"/paths/~1packages~1{tenantId}~1{id}/put/requestBody","description":"The updated package that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/packages/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Package"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/packages/{tenantId}/{id}","href":"packages/updatepackage","openApiOperationId":"updatePackage","summary":"Updates a package with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Package"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The package was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}},"schemaId":"components/schemas/Package","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The package 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The package could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The package 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve package based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1packages~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Package","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Package"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/packages/updatepackage"}],"panels":[]}]},"httpPath":"/packages/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Packages"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Packages","showPageActions":true},{"nodeType":"markdoc","content":"Packages"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/packages/{tenantId}","summary":"Gets all of the packages in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/listpackages","deprecated":false},{"title":"/packages/{tenantId}","summary":"Creates a new package record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/createpackage","deprecated":false},{"title":"/packages/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/executebatchoperations","deprecated":false},{"title":"/packages/{tenantId}/public/onlineStore","summary":"Get Packages for Online Store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/packages/getpackagesforonlinestore","deprecated":false},{"title":"/packages/{tenantId}/{id}","summary":"Returns a package from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/packages/deletepackage","deprecated":false},{"title":"/packages/{tenantId}/{id}","summary":"Returns a package from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/packages/getpackage","deprecated":false},{"title":"/packages/{tenantId}/{id}","summary":"Partially updates a package with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/packages/patchpackage","deprecated":false},{"title":"/packages/{tenantId}/{id}","summary":"Updates a package with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/packages/updatepackage","deprecated":false}]}]}]}]}},{"type":"group","label":"Query Definitions","link":"/apis/membership/membership-v1/query-definitions","routeSlug":"/apis/membership/membership-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/recurring-billing-runs","routeSlug":"/apis/membership/membership-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/membership/membership-v1/recurring-billing-runs/listrecurringbillingruns","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_564"}},"schemaId":"schema_564","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_564","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_564"}}},{"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/membership/membership-v1/recurring-billing-runs/createrecurringbillingrun","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/recurring-billing-runs/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/recurring-billing-runs/listrunsbytemplateid","routeSlug":"/apis/membership/membership-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_539","description":"The tenant","required":true},{"name":"template_id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"template_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/recurring-billing-runs/deleterecurringbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/recurring-billing-runs/getrecurringbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/recurring-billing-runs/patchrecurringbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/recurring-billing-runs/updaterecurringbillingrun","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Section Dues Products","link":"/apis/membership/membership-v1/section-dues-products","routeSlug":"/apis/membership/membership-v1/section-dues-products","items":[{"label":"Gets all of the section dues products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/listsectionduesproducts","routeSlug":"/apis/membership/membership-v1/section-dues-products/listsectionduesproducts","metadata":{"seo":{"title":"Gets all of the section dues products in the system.","description":"This method will scan all section dues products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSectionDuesProducts","name":"Gets all of the section dues products in the system.","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the section dues products 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 section dues products 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sectionDuesProducts/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sectionDuesProducts/{tenantId}","href":"section-dues-products/listsectionduesproducts","openApiOperationId":"listSectionDuesProducts","summary":"Gets all of the section dues products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section dues productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}},"schemaId":"schema_565","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_565","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_565"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/listsectionduesproducts"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}"},{"label":"Creates a new section dues product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/createsectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/createsectionduesproduct","metadata":{"seo":{"title":"Creates a new section dues product record that does not already exist.","description":"This method will auto-generate an ID and create a new section dues product. If an ID is specified for the section dues product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSectionDuesProduct","name":"Creates a new section dues product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new section dues product 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 section dues product. If an ID is specified for the section dues product, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sectionDuesProducts~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/SectionDuesProduct"}},"schemaId":"components/schemas/SectionDuesProduct","pointer":"/paths/~1sectionDuesProducts~1{tenantId}/post/requestBody","description":"The section dues product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sectionDuesProducts/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sectionDuesProducts/{tenantId}","href":"section-dues-products/createsectionduesproduct","openApiOperationId":"createSectionDuesProduct","summary":"Creates a new section dues product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SectionDuesProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section dues product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"schemaId":"components/schemas/SectionDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section dues product 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The section dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to add section dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/createsectionduesproduct"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/executebatchoperations","routeSlug":"/apis/membership/membership-v1/section-dues-products/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/~1sectionDuesProducts~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sectionDuesProducts~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/~1sectionDuesProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sectionDuesProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/sectionDuesProducts/{tenantId}/batch","href":"section-dues-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~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":"/section-dues-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}/batch"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/listproductsbysectionid","routeSlug":"/apis/membership/membership-v1/section-dues-products/listproductsbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductsBySectionId","name":"Returns a list of records with the specified section_id","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1section~1{section_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified section_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 section_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_539","description":"The tenant","required":true},{"name":"section_id","in":"path","schemaId":"schema_539","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The section_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1section~1{section_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1section~1{section_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sectionDuesProducts/{tenantId}/section/{section_id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"section_id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sectionDuesProducts/{tenantId}/section/{section_id}","href":"section-dues-products/listproductsbysectionid","openApiOperationId":"listProductsBySectionId","summary":"Returns a list of records with the specified section_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/ListSectionDuesProductsResponse"}},"schemaId":"components/schemas/ListSectionDuesProductsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1section~1{section_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSectionDuesProductsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSectionDuesProductsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/listproductsbysectionid"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}/section/{section_id}"},{"label":"Returns a section dues product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/deletesectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/deletesectionduesproduct","metadata":{"seo":{"title":"Returns a section dues product from the system by its ID.","description":"This method will delete a section dues product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSectionDuesProduct","name":"Returns a section dues product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a section dues product 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 section dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section dues product to delete.","required":true}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sectionDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/sectionDuesProducts/{tenantId}/{id}","href":"section-dues-products/deletesectionduesproduct","openApiOperationId":"deleteSectionDuesProduct","summary":"Returns a section dues product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section dues product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The section dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to delete section dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/deletesectionduesproduct"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"},{"label":"Returns a section dues product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/getsectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/getsectionduesproduct","metadata":{"seo":{"title":"Returns a section dues product from the system by its ID.","description":"This method will look up a section dues product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSectionDuesProduct","name":"Returns a section dues product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a section dues product 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 section dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section dues product to return.","required":true}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sectionDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sectionDuesProducts/{tenantId}/{id}","href":"section-dues-products/getsectionduesproduct","openApiOperationId":"getSectionDuesProduct","summary":"Returns a section dues product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section dues product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"schemaId":"components/schemas/SectionDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/getsectionduesproduct"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"},{"label":"Partially updates a section dues product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/patchsectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/patchsectionduesproduct","metadata":{"seo":{"title":"Partially updates a section dues product with the specified ID.","description":"This method will patch an existing section dues product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSectionDuesProduct","name":"Partially updates a section dues product with the specified ID.","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a section dues product 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 section dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section dues product to patch.","required":true}],"pointer":"/paths/~1sectionDuesProducts~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1sectionDuesProducts~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":"/sectionDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sectionDuesProducts/{tenantId}/{id}","href":"section-dues-products/patchsectionduesproduct","openApiOperationId":"patchSectionDuesProduct","summary":"Partially updates a section dues product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section dues product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"schemaId":"components/schemas/SectionDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The section dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/patchsectionduesproduct"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"},{"label":"Updates a section dues product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/updatesectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/updatesectionduesproduct","metadata":{"seo":{"title":"Updates a section dues product with the specified ID.","description":"This method will update an existing section dues product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSectionDuesProduct","name":"Updates a section dues product with the specified ID.","isWebhook":false,"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a section dues product 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 section dues product 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section dues product to update.","required":true}],"pointer":"/paths/~1sectionDuesProducts~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/SectionDuesProduct"}},"schemaId":"components/schemas/SectionDuesProduct","pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated section dues product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/sectionDuesProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sectionDuesProducts/{tenantId}/{id}","href":"section-dues-products/updatesectionduesproduct","openApiOperationId":"updateSectionDuesProduct","summary":"Updates a section dues product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SectionDuesProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section dues product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}},"schemaId":"components/schemas/SectionDuesProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section dues product 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section dues product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The section dues product 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section dues product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionDuesProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionDuesProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDuesProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-dues-products/updatesectionduesproduct"}],"panels":[]}]},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Section Dues Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Section Dues Products","showPageActions":true},{"nodeType":"markdoc","content":"Section Dues Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sectionDuesProducts/{tenantId}","summary":"Gets all of the section dues products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/section-dues-products/listsectionduesproducts","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}","summary":"Creates a new section dues product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/section-dues-products/createsectionduesproduct","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/section-dues-products/executebatchoperations","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}/section/{section_id}","summary":"Returns a list of records with the specified section_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/section-dues-products/listproductsbysectionid","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}/{id}","summary":"Returns a section dues product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/section-dues-products/deletesectionduesproduct","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}/{id}","summary":"Returns a section dues product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/section-dues-products/getsectionduesproduct","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}/{id}","summary":"Partially updates a section dues product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/section-dues-products/patchsectionduesproduct","deprecated":false},{"title":"/sectionDuesProducts/{tenantId}/{id}","summary":"Updates a section dues product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/section-dues-products/updatesectionduesproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Section Types","link":"/apis/membership/membership-v1/section-types","routeSlug":"/apis/membership/membership-v1/section-types","items":[{"label":"Gets all of the section types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/listsectiontypes","routeSlug":"/apis/membership/membership-v1/section-types/listsectiontypes","metadata":{"seo":{"title":"Gets all of the section types in the system.","description":"This method will scan all section types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSectionTypes","name":"Gets all of the section types in the system.","isWebhook":false,"pointer":"/paths/~1sectionTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the section 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 section 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sectionTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1sectionTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sectionTypes/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sectionTypes/{tenantId}","href":"section-types/listsectiontypes","openApiOperationId":"listSectionTypes","summary":"Gets all of the section types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_566"}},"schemaId":"schema_566","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_566","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_566"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-types/listsectiontypes"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}"},{"label":"Creates a new section type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/createsectiontype","routeSlug":"/apis/membership/membership-v1/section-types/createsectiontype","metadata":{"seo":{"title":"Creates a new section type record that does not already exist.","description":"This method will auto-generate an ID and create a new section type. If an ID is specified for the section type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSectionType","name":"Creates a new section type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1sectionTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new section 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 section type. If an ID is specified for the section 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sectionTypes~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/SectionType"}},"schemaId":"components/schemas/SectionType","pointer":"/paths/~1sectionTypes~1{tenantId}/post/requestBody","description":"The section type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sectionTypes/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SectionType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/sectionTypes/{tenantId}","href":"section-types/createsectiontype","openApiOperationId":"createSectionType","summary":"Creates a new section type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SectionType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SectionType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}},"schemaId":"components/schemas/SectionType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to add section 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-types/createsectiontype"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/section-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/~1sectionTypes~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sectionTypes~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/~1sectionTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sectionTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/sectionTypes/{tenantId}/batch","href":"section-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~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":"/section-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}/batch"},{"label":"Returns a section type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/deletesectiontype","routeSlug":"/apis/membership/membership-v1/section-types/deletesectiontype","metadata":{"seo":{"title":"Returns a section type from the system by its ID.","description":"This method will delete a section type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSectionType","name":"Returns a section type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section type to delete.","required":true}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sectionTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/sectionTypes/{tenantId}/{id}","href":"section-types/deletesectiontype","openApiOperationId":"deleteSectionType","summary":"Returns a section type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section 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_541"},{"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_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to delete section 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-types/deletesectiontype"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}/{id}"},{"label":"Returns a section type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/getsectiontype","routeSlug":"/apis/membership/membership-v1/section-types/getsectiontype","metadata":{"seo":{"title":"Returns a section type from the system by its ID.","description":"This method will look up a section type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSectionType","name":"Returns a section type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section type to return.","required":true}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sectionTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sectionTypes/{tenantId}/{id}","href":"section-types/getsectiontype","openApiOperationId":"getSectionType","summary":"Returns a section type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}},"schemaId":"components/schemas/SectionType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-types/getsectiontype"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}/{id}"},{"label":"Partially updates a section type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/patchsectiontype","routeSlug":"/apis/membership/membership-v1/section-types/patchsectiontype","metadata":{"seo":{"title":"Partially updates a section type with the specified ID.","description":"This method will patch an existing section type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSectionType","name":"Partially updates a section type with the specified ID.","isWebhook":false,"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section type to patch.","required":true}],"pointer":"/paths/~1sectionTypes~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1sectionTypes~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":"/sectionTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/sectionTypes/{tenantId}/{id}","href":"section-types/patchsectiontype","openApiOperationId":"patchSectionType","summary":"Partially updates a section type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}},"schemaId":"components/schemas/SectionType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section 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_541"},{"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_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-types/patchsectiontype"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}/{id}"},{"label":"Updates a section type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/updatesectiontype","routeSlug":"/apis/membership/membership-v1/section-types/updatesectiontype","metadata":{"seo":{"title":"Updates a section type with the specified ID.","description":"This method will update an existing section type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSectionType","name":"Updates a section type with the specified ID.","isWebhook":false,"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section type to update.","required":true}],"pointer":"/paths/~1sectionTypes~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/SectionType"}},"schemaId":"components/schemas/SectionType","pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated section type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/sectionTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SectionType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/sectionTypes/{tenantId}/{id}","href":"section-types/updatesectiontype","openApiOperationId":"updateSectionType","summary":"Updates a section type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SectionType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SectionType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}},"schemaId":"components/schemas/SectionType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section 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_541"},{"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_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sectionTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/section-types/updatesectiontype"}],"panels":[]}]},"httpPath":"/sectionTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Section Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Section Types","showPageActions":true},{"nodeType":"markdoc","content":"Section Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sectionTypes/{tenantId}","summary":"Gets all of the section types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/section-types/listsectiontypes","deprecated":false},{"title":"/sectionTypes/{tenantId}","summary":"Creates a new section type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/section-types/createsectiontype","deprecated":false},{"title":"/sectionTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/section-types/executebatchoperations","deprecated":false},{"title":"/sectionTypes/{tenantId}/{id}","summary":"Returns a section type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/section-types/deletesectiontype","deprecated":false},{"title":"/sectionTypes/{tenantId}/{id}","summary":"Returns a section type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/section-types/getsectiontype","deprecated":false},{"title":"/sectionTypes/{tenantId}/{id}","summary":"Partially updates a section type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/section-types/patchsectiontype","deprecated":false},{"title":"/sectionTypes/{tenantId}/{id}","summary":"Updates a section type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/section-types/updatesectiontype","deprecated":false}]}]}]}]}},{"type":"group","label":"Sections","link":"/apis/membership/membership-v1/sections","routeSlug":"/apis/membership/membership-v1/sections","items":[{"label":"Gets all of the sections in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/listsections","routeSlug":"/apis/membership/membership-v1/sections/listsections","metadata":{"seo":{"title":"Gets all of the sections in the system.","description":"This method will scan all sections and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSections","name":"Gets all of the sections in the system.","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the sections 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 sections 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sections~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1sections~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sections/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sections/{tenantId}","href":"sections/listsections","openApiOperationId":"listSections","summary":"Gets all of the sections in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 sectionswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}},"schemaId":"schema_567","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_567","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_567"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/listsections"}],"panels":[]}]},"httpPath":"/sections/{tenantId}"},{"label":"Creates a new section record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/createsection","routeSlug":"/apis/membership/membership-v1/sections/createsection","metadata":{"seo":{"title":"Creates a new section record that does not already exist.","description":"This method will auto-generate an ID and create a new section. If an ID is specified for the section, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSection","name":"Creates a new section record that does not already exist.","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new section 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 section. If an ID is specified for the section, 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sections~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/Section"}},"schemaId":"components/schemas/Section","pointer":"/paths/~1sections~1{tenantId}/post/requestBody","description":"The section that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sections/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Section"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sections/{tenantId}","href":"sections/createsection","openApiOperationId":"createSection","summary":"Creates a new section record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Section","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Section"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}},"schemaId":"components/schemas/Section","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to add section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Section","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/createsection"}],"panels":[]}]},"httpPath":"/sections/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/executebatchoperations","routeSlug":"/apis/membership/membership-v1/sections/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/~1sections~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sections~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/~1sections~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sections/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/sections/{tenantId}/batch","href":"sections/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~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":"/sections/executebatchoperations"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/batch"},{"label":"Returns a list of sections for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/describesectionsformembershippackage","routeSlug":"/apis/membership/membership-v1/sections/describesectionsformembershippackage","metadata":{"seo":{"title":"Returns a list of sections for a given membership package","description":"Returns a list of sections for a given membership package"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeSectionsForMembershipPackage","name":"Returns a list of sections for a given membership package","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of sections for a given membership package","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 sections for a given membership package"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"membershipPackageId","in":"path","schemaId":"schema_539","description":"The membership package to describe sections","required":true}],"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currencyCode","in":"query","schemaId":"schema_539","description":"The membership package to describe sections"}],"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"membershipPackageId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"currencyCode","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}","href":"sections/describesectionsformembershippackage","openApiOperationId":"describeSectionsForMembershipPackage","summary":"Returns a list of sections for a given membership package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/SectionDescriptionResult"}},"schemaId":"components/schemas/SectionDescriptionResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionDescriptionResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDescriptionResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/describesectionsformembershippackage"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}"},{"label":"Returns a list of sections for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/describesectionsformembershippackageandmember","routeSlug":"/apis/membership/membership-v1/sections/describesectionsformembershippackageandmember","metadata":{"seo":{"title":"Returns a list of sections for a given membership package","description":"Returns a list of sections for a given membership package"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeSectionsForMembershipPackageAndMember","name":"Returns a list of sections for a given membership package","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of sections for a given membership package","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 sections for a given membership package"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_539","description":"The tenant","required":true},{"name":"membershipPackageId","in":"path","schemaId":"schema_539","description":"The membership package to describe sections","required":true},{"name":"memberType","in":"path","schemaId":"schema_539","description":"The membership package to describe sections","required":true},{"name":"contactOrOrganizationId","in":"path","schemaId":"schema_539","description":"The membership package to describe sections","required":true}],"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"currencyCode","in":"query","schemaId":"schema_539","description":"The membership package to describe sections"}],"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}/{memberType}/{contactOrOrganizationId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"membershipPackageId","in":"path","required":true,"schemaId":"schema_539"},{"name":"memberType","in":"path","required":true,"schemaId":"schema_539"},{"name":"contactOrOrganizationId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"currencyCode","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}/{memberType}/{contactOrOrganizationId}","href":"sections/describesectionsformembershippackageandmember","openApiOperationId":"describeSectionsForMembershipPackageAndMember","summary":"Returns a list of sections for a given membership package"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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/SectionDescriptionResult"}},"schemaId":"components/schemas/SectionDescriptionResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1portal~1describeSections~1{membershipPackageId}~1{memberType}~1{contactOrOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SectionDescriptionResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SectionDescriptionResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/describesectionsformembershippackageandmember"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}/{memberType}/{contactOrOrganizationId}"},{"label":"Searches for sections using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/searchforsections","routeSlug":"/apis/membership/membership-v1/sections/searchforsections","metadata":{"seo":{"title":"Searches for sections using predefined parameters","description":"Searches for sections using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForSections","name":"Searches for sections using predefined parameters","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for sections 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 sections 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1sections~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_539","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1sections~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/SectionSearchParameters"}},"schemaId":"components/schemas/SectionSearchParameters","pointer":"/paths/~1sections~1{tenantId}~1search/post/requestBody","description":"The section that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/sections/{tenantId}/search","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SectionSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sections/{tenantId}/search","href":"sections/searchforsections","openApiOperationId":"searchForSections","summary":"Searches for sections using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SectionSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SectionSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedSectionSearchResults"}},"schemaId":"components/schemas/PagedSectionSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to add section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedSectionSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedSectionSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/searchforsections"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/search"},{"label":"Returns a section from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/deletesection","routeSlug":"/apis/membership/membership-v1/sections/deletesection","metadata":{"seo":{"title":"Returns a section from the system by its ID.","description":"This method will delete a section with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSection","name":"Returns a section from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section to delete.","required":true}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/sections/{tenantId}/{id}","href":"sections/deletesection","openApiOperationId":"deleteSection","summary":"Returns a section from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to delete section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/deletesection"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/{id}"},{"label":"Returns a section from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/getsection","routeSlug":"/apis/membership/membership-v1/sections/getsection","metadata":{"seo":{"title":"Returns a section from the system by its ID.","description":"This method will look up a section by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSection","name":"Returns a section from the system by its ID.","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section to return.","required":true}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/sections/{tenantId}/{id}","href":"sections/getsection","openApiOperationId":"getSection","summary":"Returns a section from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 section was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}},"schemaId":"components/schemas/Section","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Section","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/getsection"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/{id}"},{"label":"Partially updates a section with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/patchsection","routeSlug":"/apis/membership/membership-v1/sections/patchsection","metadata":{"seo":{"title":"Partially updates a section with the specified ID.","description":"This method will patch an existing section with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSection","name":"Partially updates a section with the specified ID.","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section to patch.","required":true}],"pointer":"/paths/~1sections~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1sections~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":"/sections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sections/{tenantId}/{id}","href":"sections/patchsection","openApiOperationId":"patchSection","summary":"Partially updates a section with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}},"schemaId":"components/schemas/Section","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Section","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/patchsection"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/{id}"},{"label":"Updates a section with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/updatesection","routeSlug":"/apis/membership/membership-v1/sections/updatesection","metadata":{"seo":{"title":"Updates a section with the specified ID.","description":"This method will update an existing section with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSection","name":"Updates a section with the specified ID.","isWebhook":false,"pointer":"/paths/~1sections~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a section 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 section 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the section to update.","required":true}],"pointer":"/paths/~1sections~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/Section"}},"schemaId":"components/schemas/Section","pointer":"/paths/~1sections~1{tenantId}~1{id}/put/requestBody","description":"The updated section that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/sections/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Section"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/sections/{tenantId}/{id}","href":"sections/updatesection","openApiOperationId":"updateSection","summary":"Updates a section with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Section","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Section"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The section was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}},"schemaId":"components/schemas/Section","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The section 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The section could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"409","description":"The section 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve section based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1sections~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Section","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Section"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/sections/updatesection"}],"panels":[]}]},"httpPath":"/sections/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Sections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sections","showPageActions":true},{"nodeType":"markdoc","content":"Sections"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sections/{tenantId}","summary":"Gets all of the sections in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sections/listsections","deprecated":false},{"title":"/sections/{tenantId}","summary":"Creates a new section record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sections/createsection","deprecated":false},{"title":"/sections/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sections/executebatchoperations","deprecated":false},{"title":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}","summary":"Returns a list of sections for a given membership package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sections/describesectionsformembershippackage","deprecated":false},{"title":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}/{memberType}/{contactOrOrganizationId}","summary":"Returns a list of sections for a given membership package","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sections/describesectionsformembershippackageandmember","deprecated":false},{"title":"/sections/{tenantId}/search","summary":"Searches for sections using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/sections/searchforsections","deprecated":false},{"title":"/sections/{tenantId}/{id}","summary":"Returns a section from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/sections/deletesection","deprecated":false},{"title":"/sections/{tenantId}/{id}","summary":"Returns a section from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/sections/getsection","deprecated":false},{"title":"/sections/{tenantId}/{id}","summary":"Partially updates a section with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/sections/patchsection","deprecated":false},{"title":"/sections/{tenantId}/{id}","summary":"Updates a section with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/sections/updatesection","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/apis/membership/membership-v1/settings","routeSlug":"/apis/membership/membership-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/membership/membership-v1/settings/deletesetting","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1settings~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"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/membership/membership-v1/settings/getsetting","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/settings/patchsetting","routeSlug":"/apis/membership/membership-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_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"405"},{"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/membership/membership-v1/settings/createsetting","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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","405","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"405"},{"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/membership/membership-v1/settings/updatesetting","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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","405","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"405"},{"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/membership/membership-v1/statistics","routeSlug":"/apis/membership/membership-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/statistics/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/statistics/getstatistic","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"Parameters to the query"},{"name":"recalculate","in":"query","schemaId":"schema_561","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"parameters","in":"query","required":false,"schemaId":"schema_539"},{"name":"recalculate","in":"query","required":false,"schemaId":"schema_561"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/status-reasons","routeSlug":"/apis/membership/membership-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/membership/membership-v1/status-reasons/liststatusreasons","routeSlug":"/apis/membership/membership-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_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_568"}},"schemaId":"schema_568","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1statusReasons~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_568","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_568"}}},{"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/membership/membership-v1/status-reasons/createstatusreason","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/status-reasons/executebatchoperations","routeSlug":"/apis/membership/membership-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_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/status-reasons/deletestatusreason","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1statusReasons~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"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/membership/membership-v1/status-reasons/getstatusreason","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/status-reasons/patchstatusreason","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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_542"}},"schemaId":"schema_542","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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/membership/membership-v1/status-reasons/updatestatusreason","routeSlug":"/apis/membership/membership-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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"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":"Types","link":"/apis/membership/membership-v1/types","routeSlug":"/apis/membership/membership-v1/types","items":[{"label":"Gets all of the types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/listtypes","routeSlug":"/apis/membership/membership-v1/types/listtypes","metadata":{"seo":{"title":"Gets all of the types in the system.","description":"This method will scan all types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTypes","name":"Gets all of the types in the system.","isWebhook":false,"pointer":"/paths/~1types~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the 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 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1types~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_539","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1types~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/types/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/types/{tenantId}","href":"types/listtypes","openApiOperationId":"listTypes","summary":"Gets all of the types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}},"schemaId":"schema_569","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_569","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_569"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/types/listtypes"}],"panels":[]}]},"httpPath":"/types/{tenantId}"},{"label":"Creates a new type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/createtype","routeSlug":"/apis/membership/membership-v1/types/createtype","metadata":{"seo":{"title":"Creates a new type record that does not already exist.","description":"This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createType","name":"Creates a new type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1types~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new 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 type. If an ID is specified for the 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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1types~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/Type"}},"schemaId":"components/schemas/Type","pointer":"/paths/~1types~1{tenantId}/post/requestBody","description":"The type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/types/{tenantId}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Type"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/types/{tenantId}","href":"types/createtype","openApiOperationId":"createType","summary":"Creates a new type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Type"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}},"schemaId":"components/schemas/Type","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"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_541"},{"code":"409","description":"The 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_541"},{"code":"429","description":"Limit exceeded... unable to add 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Type","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/types/createtype"}],"panels":[]}]},"httpPath":"/types/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/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/~1types~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_539","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1types~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/~1types~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/types/{tenantId}/batch","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"}],"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":"/types/{tenantId}/batch","href":"types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~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":"/types/executebatchoperations"}],"panels":[]}]},"httpPath":"/types/{tenantId}/batch"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/deletetype","routeSlug":"/apis/membership/membership-v1/types/deletetype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will delete a type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteType","name":"Returns a type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1types~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a 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 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the type to delete.","required":true}],"pointer":"/paths/~1types~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/types/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"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":"/types/{tenantId}/{id}","href":"types/deletetype","openApiOperationId":"deleteType","summary":"Returns a type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}},"schemaId":"schema_539","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The 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_541"},{"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_541"},{"code":"409","description":"The 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_541"},{"code":"429","description":"Limit exceeded... unable to delete 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_539","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_539"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/types/deletetype"}],"panels":[]}]},"httpPath":"/types/{tenantId}/{id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/gettype","routeSlug":"/apis/membership/membership-v1/types/gettype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will look up a type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getType","name":"Returns a type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1types~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a 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 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the type to return.","required":true}],"pointer":"/paths/~1types~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_539","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_539","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1types~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/types/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_539"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_539"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/types/{tenantId}/{id}","href":"types/gettype","openApiOperationId":"getType","summary":"Returns a type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.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 type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}},"schemaId":"components/schemas/Type","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Type","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/types/gettype"}],"panels":[]}]},"httpPath":"/types/{tenantId}/{id}"},{"label":"Partially updates a type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/patchtype","routeSlug":"/apis/membership/membership-v1/types/patchtype","metadata":{"seo":{"title":"Partially updates a type with the specified ID.","description":"This method will patch an existing type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchType","name":"Partially updates a type with the specified ID.","isWebhook":false,"pointer":"/paths/~1types~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a 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 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the type to patch.","required":true}],"pointer":"/paths/~1types~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_542"}},"schemaId":"schema_542","pointer":"/paths/~1types~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":"/types/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_542"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/types/{tenantId}/{id}","href":"types/patchtype","openApiOperationId":"patchType","summary":"Partially updates a type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"schema_542","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_542"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}},"schemaId":"components/schemas/Type","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The 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_541"},{"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_541"},{"code":"409","description":"The 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Type","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/types/patchtype"}],"panels":[]}]},"httpPath":"/types/{tenantId}/{id}"},{"label":"Updates a type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/updatetype","routeSlug":"/apis/membership/membership-v1/types/updatetype","metadata":{"seo":{"title":"Updates a type with the specified ID.","description":"This method will update an existing type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateType","name":"Updates a type with the specified ID.","isWebhook":false,"pointer":"/paths/~1types~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a 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 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_539","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_539","description":"The ID of the type to update.","required":true}],"pointer":"/paths/~1types~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/Type"}},"schemaId":"components/schemas/Type","pointer":"/paths/~1types~1{tenantId}~1{id}/put/requestBody","description":"The updated type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/types/{tenantId}/{id}","servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_539"},{"name":"id","in":"path","required":true,"schemaId":"schema_539"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Type"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/types/{tenantId}/{id}","href":"types/updatetype","openApiOperationId":"updateType","summary":"Updates a type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/membership/membership-v1","description":"Mock server","isMockServer":true},{"url":"https://membership.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Type","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Type"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}},"schemaId":"components/schemas/Type","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"400","description":"The 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_541"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"},{"code":"404","description":"The 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_541"},{"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_541"},{"code":"409","description":"The 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_541"},{"code":"429","description":"Limit exceeded... unable to retrieve 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_541"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_541"}],"pointer":"/paths/~1types~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Type","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Type"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/types/updatetype"}],"panels":[]}]},"httpPath":"/types/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Types","showPageActions":true},{"nodeType":"markdoc","content":"Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/types/{tenantId}","summary":"Gets all of the types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/types/listtypes","deprecated":false},{"title":"/types/{tenantId}","summary":"Creates a new type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/types/createtype","deprecated":false},{"title":"/types/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/types/executebatchoperations","deprecated":false},{"title":"/types/{tenantId}/{id}","summary":"Returns a type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/types/deletetype","deprecated":false},{"title":"/types/{tenantId}/{id}","summary":"Returns a type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/types/gettype","deprecated":false},{"title":"/types/{tenantId}/{id}","summary":"Partially updates a type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/types/patchtype","deprecated":false},{"title":"/types/{tenantId}/{id}","summary":"Updates a type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/types/updatetype","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AddOn":{"id":"components/schemas/AddOn","kind":"json-schema","title":"AddOn","data":{"additionalProperties":false,"properties":{"allow_multiple":{"description":"If true, a member can purchase more than one of this add on","title":"Allow Multiple","type":"boolean"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_order":{"description":"The display order of the add on","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"},"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_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"},"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_dues":{"description":"If set, this add on should cost money","title":"Enable Dues","type":"boolean"},"enable_eligibility":{"description":"If set, then only certain individual are eligible for this add on","title":"Enable Eligibility","type":"boolean"},"hide_from_portal":{"description":"Hide this add on from the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this add on","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this add on is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the add on","title":"Name","type":"string"},"portal_description":{"description":"Description of the add on to be displayed in the portal","title":"Portal 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 add on","title":"Type","type":"string"}},"required":["eligibility_criteria","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/AddOnProduct":{"id":"components/schemas/AddOnProduct","kind":"json-schema","title":"AddOnProduct","data":{"additionalProperties":false,"properties":{"add_on_id":{"description":"The add on to which this product is linked ","title":"Add On","type":"string"},"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"},"membership_package_id":{"description":"The membership package associated with this product","title":"Membership Package","type":"string"},"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":["membership-add-on-products"],"title":"Type","type":"string"}},"required":["add_on_id","bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","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/AddOnType":{"id":"components/schemas/AddOnType","kind":"json-schema","title":"AddOnType","data":{"additionalProperties":false,"properties":{"allowed_membership_type_ids":{"description":"The ids of membership types that are allowed to receive this add on","items":{"type":"string"},"minItems":1,"title":"Allowed Membership Types","type":"array"},"display_order":{"description":"The order to display these types in the portal","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this add on type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this add on type is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the add on type","title":"Name","type":"string"},"portal_description":{"description":"Description of this type to be displayed in the portal","title":"Portal Description","type":"string"},"restrict_membership_types":{"description":"When set, only certain membership types can purchase this add on","title":"Restrict Membership Types","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":["allowed_membership_type_ids","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","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/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/Application":{"id":"components/schemas/Application","kind":"json-schema","title":"Application","data":{"additionalProperties":false,"properties":{"add_ons":{"items":{"additionalProperties":false,"properties":{"add_on_id":{"description":"The add on","title":"Add On","type":"string"},"quantity":{"description":"The quantity of add on","format":"float","minimum":1,"title":"Quantity","type":"number"}},"required":["add_on_id"],"type":"object"},"type":"array"},"additional_chapter_ids":{"description":"Additional chapter IDs","items":{"type":"string"},"title":"Additional Chapters","type":"array"},"application_group_id":{"description":"The associated application group","title":"Application Group","type":"string"},"assigned_contacts":{"items":{"additionalProperties":false,"properties":{"add_on_ids":{"description":"The add ons this individual would like","items":{"type":"string"},"title":"Add Ons","type":"array"},"chapter_ids":{"description":"The chapters this individual would like to join","items":{"type":"string"},"title":"Chapters","type":"array"},"contact_id":{"oneOf":[{"x-required":true}],"title":"Contact","type":"string"},"new_contact_info":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{},"title":"New Contact Info","type":"object"},"section_ids":{"description":"The sections this individual would like to join","items":{"type":"string"},"title":"Sections","type":"array"},"type":{"enum":["existing","new"],"title":"Type","type":"string"}},"required":["type"],"type":"object"},"type":"array"},"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"},"chapter_id":{"description":"The chapter ID","title":"Chapter","type":"string"},"contact_id":{"description":"The owner of this membership","title":"Contact","type":"string"},"corporate_member_ids":{"description":"The individuals that should receive the corporate membership","items":{"type":"string"},"title":"Corporate Members","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the application","format":"date-time","title":"Date","type":"string"},"do_not_renew":{"description":"Do not attempt to automatically renew this membership","title":"Do Not Renew","type":"boolean"},"do_not_show_in_directory":{"description":"Whether or not this membership should be hidden from the directory","title":"Do Not Show In Directory","type":"boolean"},"group_application_process_id":{"description":"The associated application group application","title":"Group Application Process","type":"string"},"group_order":{"description":"The order of the application in the group","format":"float","title":"Group Order","type":"number"},"hidden_directory_fields":{"description":"The fields that should not be shown for this member in the directory","items":{"type":"string"},"title":"Hidden Directory Fields","type":"array"},"id":{"description":"The unique, string identifier of this application","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"included_merchandise":{"items":{"additionalProperties":false,"properties":{"modifier_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"description":"The modifier option ID","title":"Option","type":"string"},"option_name":{"title":"Option Name","type":"string"},"value":{"description":"The value of the option","title":"Value","type":"string"}},"required":["option_id"],"type":"object"},"type":"array"},"product_id":{"description":"The id of the product","title":"Product","type":"string"},"product_type":{"description":"The type of product","title":"Product Type","type":"string"},"sku":{"description":"The SKU of the product, if applicable","title":"Sku","type":"string"},"variant_options":{"items":{"additionalProperties":false,"properties":{"option_id":{"description":"The variant option ID","title":"Option","type":"string"},"option_name":{"title":"Option Name","type":"string"},"value":{"description":"The value of the option","title":"Value","type":"string"}},"required":["option_id"],"type":"object"},"type":"array"}},"required":["product_id","product_type"],"type":"object"},"type":"array"},"last_review_status_change":{"description":"The date that the review status was last changed","format":"date-time","title":"Last Review Status Change","type":"string"},"membership_package_id":{"description":"The membership package","title":"Membership Package","type":"string"},"membership_type_id":{"description":"The membership type","title":"Membership Type","type":"string"},"name":{"description":"The name on the application","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"order_id":{"description":"The order id","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item id","title":"Order Line Item","type":"string"},"organization_id":{"description":"The organizational owner of this membership","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"},"override_join_date":{"description":"Allows for applications that override join date","title":"Override Join Date","type":"string"},"owner_type":{"description":"The type of owner","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"},"process_id":{"description":"The application process used","title":"Process","type":"string"},"referral_contact_id":{"description":"The individual who referred this member","title":"Referral Contact","type":"string"},"renew_automatically":{"description":"If set, then this membership will automatically renew with the card on file","title":"Renew Automatically","type":"boolean"},"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"},"section_ids":{"items":{"type":"string"},"title":"Sections","type":"array"},"status":{"description":"The membership application status","enum":["approved","not yet submitted","rejected","under review"],"title":"Status","type":"string"},"status_reason_id":{"description":"The reason that a membership application is in the specific 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"},"total_score":{"description":"The total score for this submission in the most recent round","format":"float","title":"Total Score","type":"number"},"type":{"enum":["change affiliations","join","reinstatement","renewal"],"title":"Type","type":"string"}},"required":["bucket_id","contact_id","id","name","organization_id","owner_type","process_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/ApplicationGroup":{"id":"components/schemas/ApplicationGroup","kind":"json-schema","title":"ApplicationGroup","data":{"additionalProperties":false,"properties":{"contact_id":{"description":"The contact that owns this group","title":"Contact","type":"string"},"id":{"description":"The unique, string identifier of this application group","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"name":{"description":"The name of the application group","title":"Name","type":"string"},"number_of_applications":{"description":"The number of applications in the group","format":"float","title":"Number Of Applications","type":"number"},"order_id":{"description":"The order for this group","title":"Order","type":"string"},"organization_id":{"description":"The organization","title":"Organization","type":"string"},"owner_type":{"enum":["contact","organization"],"title":"Owner Type","type":"string"},"process_id":{"description":"The group application process associated with this group","title":"Process","type":"string"},"status":{"description":"The status of this group","enum":["in progress","processed"],"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":{"description":"Total cost for the group","format":"float","title":"Total","type":"number"}},"required":["contact_id","id","name","organization_id","owner_type","process_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ApplicationGroupSearchParameters":{"id":"components/schemas/ApplicationGroupSearchParameters","kind":"json-schema","title":"ApplicationGroupSearchParameters","data":{"additionalProperties":false,"properties":{"contact_id":{"items":{"type":"string"},"title":"Contact","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"process_id":{"items":{"type":"string"},"title":"Process","type":"array"}},"type":"object"}},"components/schemas/ApplicationGroupSearchResults":{"id":"components/schemas/ApplicationGroupSearchResults","kind":"json-schema","title":"ApplicationGroupSearchResults","data":{"additionalProperties":false,"properties":{"contact_id":{"description":"The contact that owns this group","title":"Contact","type":"string"},"id":{"description":"The unique, string identifier of this application group","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"name":{"description":"The name of the application group","title":"Name","type":"string"},"number_of_applications":{"description":"The number of applications in the group","format":"float","title":"Number Of Applications","type":"number"},"order_id":{"description":"The order for this group","title":"Order","type":"string"},"organization_id":{"description":"The organization","title":"Organization","type":"string"},"owner_type":{"enum":["contact","organization"],"title":"Owner Type","type":"string"},"process_id":{"description":"The group application process associated with this group","title":"Process","type":"string"},"status":{"description":"The status of this group","enum":["in progress","processed"],"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":{"description":"Total cost for the group","format":"float","title":"Total","type":"number"}},"required":["contact_id","id","name","organization_id","owner_type","process_id","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":{"applicable_origins":{"description":"The origin types that are applicable to this process - blank for just principle","items":{"type":"string"},"title":"Applicable Origins","type":"array"},"application_confirmation_email":{"additionalProperties":false,"description":"The email to send when the application is received","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"},"approval_chapter_ids":{"items":{"type":"string"},"minItems":1,"title":"Approval Chapters","type":"array"},"approval_lambda_function_id":{"title":"Approval Lambda Function","type":"string"},"change_options":{"additionalProperties":false,"properties":{"change_fee_id":{"description":"The product to use when changing information","title":"Change Fee","type":"string"},"prorate_add_on_dues":{"description":"If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership","title":"Prorate Add On Dues","type":"boolean"},"prorate_chapter_dues":{"description":"If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership","title":"Prorate Chapter Dues","type":"boolean"},"prorate_section_dues":{"description":"If set, if someone adds a section, then the system should prorate those dues based on the amount of time left in the membership","title":"Prorate Section Dues","type":"boolean"}},"required":["change_fee_id"],"title":"Change 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"},"custom_application_generation_logic_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 Application Generation Logic Options","type":"object"},"custom_application_pre_processing_lambda_function_id":{"title":"Custom Application Pre Processing Lambda Function","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"description":{"description":"A description of the process to help the user understand whether to choose","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":"The display order","format":"float","title":"Display Order","type":"number"},"do_not_send_activation_email_until_membership_is_paid":{"description":"If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment","title":"Do Not Send Activation Email Until Membership Is Paid","type":"boolean"},"do_not_set_default_renewal_package":{"description":"If true, do NOT set the default package for renewals, instead forcing them to choose one","title":"Do Not Set Default Renewal Package","type":"boolean"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria for eligibility","properties":{},"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_custom_application_generation_logic":{"description":"If set, the application generation logic will call a custom lambda function","title":"Enable Custom Application Generation Logic","type":"boolean"},"enable_custom_application_pre_processing":{"description":"If set, custom order generation logic is run","title":"Enable Custom Application Pre Processing","type":"boolean"},"enable_eligibility_criteria":{"description":"Should allow eligibility criteria","title":"Enable Eligibility Criteria","type":"boolean"},"enable_membership_activation_email":{"description":"Whether or not to send an email when the membership is actually activated","title":"Enable Membership Activation Email","type":"boolean"},"enable_order_generation_rules":{"description":"Whether order generation rules apply","title":"Enable Order Generation Rules","type":"boolean"},"enable_section_restrictions":{"description":"Whether section requirements are enabled for this membership type","title":"Enable Section Restrictions","type":"boolean"},"form_id":{"description":"The default application form for this process membership","pattern":"^membership-applications__.*","title":"Form","type":"string"},"id":{"description":"The unique, string identifier of this application process","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this process is active","title":"Is Active","type":"boolean"},"membership_activation_email":{"additionalProperties":false,"description":"Email to send once the membership 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":"Membership Activation Email","type":"object"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"title":"Membership Types","type":"array"},"memberships_require_approval":{"description":"Whether or not memberships require approval","enum":["always","based on chapter","custom","never"],"title":"Memberships Require Approval","type":"string"},"name":{"description":"The name of the application process","title":"Name","type":"string"},"order_generation_rules":{"items":{"additionalProperties":false,"properties":{"add_on_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"add_ons":{"items":{"additionalProperties":false,"properties":{"add_on_id":{"description":"The add on id to add","title":"Add On","type":"string"},"quantity":{"description":"The add on amount","format":"float","minimum":1,"oneOf":[{"x-required":true}],"title":"Quantity","type":"number"},"quantity_calculation_strategy":{"enum":["static value"],"title":"Quantity Calculation Strategy","type":"string"}},"required":["add_on_id","quantity_calculation_strategy"],"type":"object"},"minItems":1,"type":"array"}},"required":["add_ons"],"title":"Add On Options","type":"object"},"assign_add_ons":{"title":"Assign Add Ons","type":"boolean"},"assign_package":{"title":"Assign Package","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":"A description of the rule","title":"Name","type":"string"},"package_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"package_id":{"description":"The package id to add","title":"Package","type":"string"}},"required":["package_id"],"title":"Package Options","type":"object"}},"required":["matching_conditions","name"],"type":"object"},"minItems":1,"type":"array"},"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"},"organizational_membership_options":{"additionalProperties":false,"properties":{"allow_admin_to_modify_add_ons":{"description":"If set, membership group admins can add/change add ons","title":"Allow Admin To Modify Add Ons","type":"boolean"},"allow_admin_to_modify_chapters":{"description":"If set, membership group admins can add/change chapters","title":"Allow Admin To Modify Chapters","type":"boolean"},"allow_admin_to_modify_sections":{"description":"If set, membership group admins can add/change sections","title":"Allow Admin To Modify Sections","type":"boolean"},"quick_add_contact_options":{"additionalProperties":false,"description":"UI options for how the add org contacts should function","properties":{},"title":"Quick Add Contact Options","type":"object"}},"required":["quick_add_contact_options"],"title":"Organizational Membership Options","type":"object"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"reinstatement_options":{"additionalProperties":false,"properties":{"calculate_reinstatement_period_using":{"description":"The mechanism to use to calculate the reinstatement period","enum":["default","expiration date","termination date"],"title":"Calculate Reinstatement Period Using","type":"string"},"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"},"restrict_membership_packages":{"description":"The packages  in this path are restricted","title":"Restrict Membership Packages","type":"boolean"},"restrict_membership_types":{"description":"The membership types in this path are restricted","title":"Restrict Membership Types","type":"boolean"},"restrict_organization_types":{"description":"Restrict to certain types of organizations","title":"Restrict Organization Types","type":"boolean"},"section_restrictions":{"additionalProperties":false,"properties":{"maximum_number_of_sections":{"description":"The maximum number of overall sections","format":"float","title":"Maximum Number Of Sections","type":"number"},"minimum_number_of_sections":{"description":"The minimum number of overall sections","format":"float","title":"Minimum Number Of Sections","type":"number"},"section_type_restrictions":{"items":{"additionalProperties":false,"properties":{"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max # of sections"},"children":[]}]}]}],"format":"float","title":"Maximum","type":"number"},"minimum":{"description":"The minimum number of sections","format":"float","title":"Minimum","type":"number"},"section_type_id":{"description":"The required section type","title":"Section Type","type":"string"}},"type":"object"},"type":"array"}},"title":"Section Restrictions","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"},"type":{"enum":["change affiliations","join","reinstatement","renewal"],"title":"Type","type":"string"}},"required":["application_confirmation_email","approval_chapter_ids","approval_lambda_function_id","change_options","checkout_settings","contact_form_options","custom_application_generation_logic_options","custom_application_pre_processing_lambda_function_id","customer_type","eligibility_criteria","id","membership_activation_email","membership_package_ids","membership_type_ids","name","order_generation_rules","organization_form_options","organization_type_ids","organizational_membership_options","reinstatement_options","renewal_options","section_restrictions","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/ApplicationSearchParameters":{"id":"components/schemas/ApplicationSearchParameters","kind":"json-schema","title":"ApplicationSearchParameters","data":{"additionalProperties":false,"properties":{"date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"description":"IDs to search","items":{"type":"string"},"title":"ID","type":"array"},"membership_package_id":{"items":{"type":"string"},"title":"Membership Package","type":"array"},"membership_type_id":{"items":{"type":"string"},"title":"Membership Type","type":"array"},"name":{"title":"Name","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"status":{"items":{"type":"string"},"title":"Status","type":"array"},"status_reason_id":{"items":{"type":"string"},"title":"Status Reason","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":{"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"membership_package_id":{"title":"Membership Package","type":"string"},"membership_type_id":{"title":"Membership Type","type":"string"},"name":{"title":"Name","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"status":{"title":"Status","type":"string"},"status_reason_id":{"title":"Status Reason","type":"string"},"type":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/ApplicationStatusReason":{"id":"components/schemas/ApplicationStatusReason","kind":"json-schema","title":"ApplicationStatusReason","data":{"additionalProperties":false,"properties":{"applies_to":{"description":"What status this reason is applicable to","enum":["approved","not yet submitted","rejected","under review"],"title":"Applies To","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this application status reason","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this reason is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the application status reason","title":"Name","type":"string"},"priority":{"description":"The priority order, which is how these reasons will be displayed. If the status changes, the first applicable reason based on priority will be set. ","format":"float","title":"Priority","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":["applies_to","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Ballot":{"id":"components/schemas/Ballot","kind":"json-schema","title":"Ballot","data":{"additionalProperties":false,"properties":{"candidates":{"items":{"additionalProperties":false,"properties":{"candidate_id":{"description":"The candidate being voted for","title":"Candidate","type":"string"},"position_id":{"description":"The position being voted for","title":"Position","type":"string"}},"required":["candidate_id","position_id"],"type":"object"},"type":"array"},"election_id":{"description":"The election being voted on","title":"Election","type":"string"},"id":{"description":"The unique, string identifier of this ballot","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"measures":{"items":{"additionalProperties":false,"properties":{"measure_id":{"description":"The position being voted for","title":"Measure","type":"string"},"response":{"description":"The response - for now, yes/no, but potentially expandable","enum":["no","yes"],"title":"Response","type":"string"}},"required":["measure_id","response"],"type":"object"},"type":"array"},"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"},"voter_id":{"description":"The contact voting","title":"Voter","type":"string"}},"required":["election_id","id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","voter_id"],"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/BillingNotice":{"id":"components/schemas/BillingNotice","kind":"json-schema","title":"BillingNotice","data":{"additionalProperties":false,"properties":{"contact_role_ids":{"description":"The contact roles that should receive this notice (organization memberships only)","items":{"type":"string"},"title":"Contact Roles","type":"array"},"email":{"additionalProperties":false,"description":"The email for the notice","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 billing notice","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this billing notice is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the billing 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":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BillingRun":{"id":"components/schemas/BillingRun","kind":"json-schema","title":"BillingRun","data":{"additionalProperties":false,"properties":{"auto_renewal_options":{"additionalProperties":false,"properties":{"auto_renewal_failure_notice_id":{"description":"The notice to send when a membership is NOT successfully renewed","title":"Auto Renewal Failure Notice","type":"string"},"auto_renewal_success_notice_id":{"description":"The notice to send when a membership is successfully renewed","title":"Auto Renewal Success 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"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Auto Renewal Options","type":"object"},"auto_renewal_reminder_options":{"additionalProperties":false,"properties":{"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","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"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["reminders"],"title":"Auto Renewal Reminder Options","type":"object"},"batch_id":{"description":"The batch to use","title":"Batch","type":"string"},"drop_options":{"additionalProperties":false,"properties":{"deactivate_certifications":{"description":"If true, any active certifications held by this member are rendered inactive","title":"Deactivate Certifications","type":"boolean"},"drop_notice_id":{"description":"The notice to send when the drop occurs","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"},"expire_committee_memberships":{"description":"If true, dropped members are renewed from any committees, including any inherited memberships","title":"Expire Committee Memberships","type":"boolean"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"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"},"expiring_credit_card_reminders_options":{"additionalProperties":false,"properties":{"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","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"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["reminders"],"title":"Expiring Credit Card Reminders Options","type":"object"},"generate_renewal_notices":{"description":"Whether this template should be generating renewal notices","title":"Generate Renewal Notices","type":"boolean"},"generate_renewal_orders":{"description":"Whether this template should be generating renewal orders","title":"Generate Renewal Orders","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_auto_renewals":{"description":"Whether this template should be performing auto renewals","title":"Perform Auto Renewals","type":"boolean"},"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":"If this was part of a recurring billing run, the ID","title":"Recurring Billing Run","type":"string"},"renewal_notice_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"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"renewal_notice_id":{"description":"The notice to send when a renewal order is created","title":"Renewal Notice","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Renewal Notice Options","type":"object"},"renewal_order_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"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"pro_forma":{"description":"Whether or not this should generate pro forma orders/invoices","title":"Pro Forma","type":"boolean"},"renewal_order_notice_id":{"description":"The notice to send when a renewal order is created","title":"Renewal Order Notice","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Renewal Order Options","type":"object"},"renewal_reminder_options":{"additionalProperties":false,"properties":{"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","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"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"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_auto_renewal_reminders":{"description":"Whether this template should be generating reminders","title":"Send Auto Renewal Reminders","type":"boolean"},"send_expiring_credit_card_reminders":{"description":"Whether to warn  that someone's card is going to expire","title":"Send Expiring Credit Card Reminders","type":"boolean"},"send_renewal_reminders":{"description":"Whether this template should be generating reminders","title":"Send Renewal Reminders","type":"boolean"},"statistics":{"additionalProperties":false,"properties":{"all_actions":{"additionalProperties":false,"properties":{"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"}},"title":"All Actions","type":"object"},"auto_renewal_reminders":{"additionalProperties":false,"properties":{"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"}},"title":"Auto Renewal Reminders","type":"object"},"auto_renewals":{"additionalProperties":false,"properties":{"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"}},"title":"Auto Renewals","type":"object"},"drops":{"additionalProperties":false,"properties":{"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"}},"title":"Drops","type":"object"},"expiring_credit_card_reminders":{"additionalProperties":false,"properties":{"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"}},"title":"Expiring Credit Card Reminders","type":"object"},"renewal_notices":{"additionalProperties":false,"properties":{"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"}},"title":"Renewal Notices","type":"object"},"renewal_orders":{"additionalProperties":false,"properties":{"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"}},"title":"Renewal Orders","type":"object"},"renewal_reminders":{"additionalProperties":false,"properties":{"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"}},"title":"Renewal Reminders","type":"object"}},"title":"Statistics","type":"object"},"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 id of the template that generated this billing run","title":"Template","type":"string"}},"required":["auto_renewal_options","auto_renewal_reminder_options","drop_options","expiring_credit_card_reminders_options","id","name","renewal_notice_options","renewal_order_options","renewal_reminder_options","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BillingRunAction":{"id":"components/schemas/BillingRunAction","kind":"json-schema","title":"BillingRunAction","data":{"additionalProperties":false,"properties":{"billing_run_id":{"description":"The billing run ID","title":"Billing Run","type":"string"},"date":{"description":"The action date","format":"date-time","title":"Date","type":"string"},"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"},"failure_notice_id":{"description":"Notice to use when the action fails","title":"Failure Notice","type":"string"},"id":{"description":"The unique, string identifier of this billing run action","pattern":"^[\\w|\\-|#|_|:]+$","title":"ID","type":"string"},"last_refresh_date":{"description":"The date this action was last refreshed","format":"date-time","title":"Last Refresh Date","type":"string"},"membership_expiration_date":{"description":"The membership expiration date","title":"Membership Expiration Date","type":"string"},"membership_id":{"description":"The membership ID on which this action is acting","title":"Membership","type":"string"},"name":{"description":"Name of the membership","title":"Name","type":"string"},"order_id":{"description":"The relevant order, if applicable","title":"Order","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"},"reminder_number":{"description":"The reminder number, if this action is a reminder","format":"float","title":"Reminder Number","type":"number"},"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"},"success_notice_id":{"description":"The notice to use when the action succeeds","title":"Success Notice","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":{"enum":["auto renewal order","auto renewal reminder","drop","expiring card reminder","renewal notice","renewal order","renewal reminder"],"title":"Type","type":"string"}},"required":["billing_run_id","date","id","membership_id","name","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/BillingRunSearchParameters":{"id":"components/schemas/BillingRunSearchParameters","kind":"json-schema","title":"BillingRunSearchParameters","data":{"additionalProperties":false,"properties":{"generate_renewal_notices":{"items":{"type":"boolean"},"title":"Generate Renewal Notices","type":"array"},"generate_renewal_orders":{"items":{"type":"boolean"},"title":"Generate Renewal Orders","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"perform_auto_renewals":{"items":{"type":"boolean"},"title":"Perform Auto Renewals","type":"array"},"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_auto_renewal_reminders":{"items":{"type":"boolean"},"title":"Send Auto Renewal Reminders","type":"array"},"send_expiring_credit_card_reminders":{"items":{"type":"boolean"},"title":"Send Expiring Credit Card 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":{"auto_renewal_options":{"additionalProperties":false,"properties":{"auto_renewal_failure_notice_id":{"description":"The notice to send when a membership is NOT successfully renewed","title":"Auto Renewal Failure Notice","type":"string"},"auto_renewal_success_notice_id":{"description":"The notice to send when a membership is successfully renewed","title":"Auto Renewal Success 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"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Auto Renewal Options","type":"object"},"auto_renewal_reminder_options":{"additionalProperties":false,"properties":{"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","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"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["reminders"],"title":"Auto Renewal Reminder Options","type":"object"},"description":{"description":"A description of the template","title":"Description","type":"string"},"drop_options":{"additionalProperties":false,"properties":{"deactivate_certifications":{"description":"If true, any active certifications held by this member are rendered inactive","title":"Deactivate Certifications","type":"boolean"},"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"},"expire_committee_memberships":{"description":"If true, dropped members are renewed from any committees, including any inherited memberships","title":"Expire Committee Memberships","type":"boolean"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Drop Options","type":"object"},"expiring_credit_card_reminders_options":{"additionalProperties":false,"properties":{"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","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"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["reminders"],"title":"Expiring Credit Card Reminders Options","type":"object"},"generate_renewal_notices":{"description":"Whether this template should be generating renewal notices","title":"Generate Renewal Notices","type":"boolean"},"generate_renewal_orders":{"description":"Whether this template should be generating renewal orders","title":"Generate Renewal Orders","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_auto_renewals":{"description":"Whether this template should be performing auto renewals","title":"Perform Auto Renewals","type":"boolean"},"perform_drops":{"description":"Whether this template should be dropping expired members","title":"Perform Drops","type":"boolean"},"renewal_notice_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"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"renewal_notice_id":{"description":"The notice to send when a renewal order is created","title":"Renewal Notice","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Renewal Notice Options","type":"object"},"renewal_order_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"},"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","type":"string"},"pro_forma":{"description":"Whether or not this should generate pro forma orders/invoices","title":"Pro Forma","type":"boolean"},"renewal_order_notice_id":{"description":"The notice to send when a renewal order is created","title":"Renewal Order Notice","type":"string"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["expiration_date_range_end","expiration_date_range_start"],"title":"Renewal Order Options","type":"object"},"renewal_reminder_options":{"additionalProperties":false,"properties":{"include_only_certain_membership_packages":{"description":"Whether the process should apply only to certain member packages","title":"Include Only Certain Membership Packages","type":"boolean"},"include_only_certain_membership_types":{"description":"Whether the process should apply only to certain member types","title":"Include Only Certain Membership Types","type":"boolean"},"include_only_certain_status_reasons":{"description":"Whether the process should apply only to certain member status reasons","title":"Include Only Certain Status Reasons","type":"boolean"},"membership_package_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Packages","type":"array"},"membership_type_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Membership Types","type":"array"},"new_status_reason_id":{"description":"Change the status reason","title":"New Status Reason","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"},"status_reason_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Status Reasons","type":"array"}},"required":["reminders"],"title":"Renewal Reminder Options","type":"object"},"send_auto_renewal_reminders":{"description":"Whether this template should be generating reminders","title":"Send Auto Renewal Reminders","type":"boolean"},"send_expiring_credit_card_reminders":{"description":"Whether to warn  that someone's card is going to expire","title":"Send Expiring Credit Card Reminders","type":"boolean"},"send_renewal_reminders":{"description":"Whether this template should be generating reminders","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"}},"required":["auto_renewal_options","auto_renewal_reminder_options","drop_options","expiring_credit_card_reminders_options","id","name","renewal_notice_options","renewal_order_options","renewal_reminder_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ChangeFee":{"id":"components/schemas/ChangeFee","kind":"json-schema","title":"ChangeFee","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"},"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":["membership-change-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","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Chapter":{"id":"components/schemas/Chapter","kind":"json-schema","title":"Chapter","data":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Description of the chapter","title":"Description","type":"string"},"email_address":{"description":"The email address of the chapter","title":"Email Address","type":"string"},"enable_dues":{"title":"Enable Dues","type":"boolean"},"enable_new_member_email":{"description":"ALlow for new members to receive an email when they join this chapter","title":"Enable New Member Email","type":"boolean"},"hide_from_portal":{"description":"Whether or not this section is displayed in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this chapter","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this is an active chapter","title":"Is Active","type":"boolean"},"linked_organization_id":{"description":"The organization linked to this chapter, if the chapter owes dues/taxes to the main organization","title":"Linked Organization","type":"string"},"name":{"description":"The name of the chapter","title":"Name","type":"string"},"new_member_email":{"additionalProperties":false,"description":"The new member email","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":"New Member Email","type":"object"},"phone_number":{"description":"Chapter phone number","title":"Phone Number","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_search_latlong":{"description":"A geocode for distance queries","title":"Sys Search Latlong","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"},"type_id":{"description":"The type of chapter","title":"Type","type":"string"},"website":{"description":"Website of the chapter","title":"Website","type":"string"}},"required":["id","name","new_member_email","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/ChapterDescriptionResult":{"id":"components/schemas/ChapterDescriptionResult","kind":"json-schema","title":"ChapterDescriptionResult","data":{"additionalProperties":false,"properties":{"chapterTypes":{"items":{"additionalProperties":false,"properties":{"chapter_type_id":{"title":"Chapter Type","type":"string"},"chapter_type_name":{"title":"Chapter Type Name","type":"string"},"chapter_type_portal_description":{"title":"Chapter Type Portal Description","type":"string"},"chapters":{"items":{"additionalProperties":false,"properties":{"chapter_id":{"title":"Chapter","type":"string"},"chapter_name":{"title":"Chapter Name","type":"string"},"currency_code":{"title":"Currency Code","type":"string"},"dues":{"format":"float","title":"Dues","type":"number"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"suggestions":{"items":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"chapter_id":{"title":"Chapter","type":"string"},"chapter_name":{"title":"Chapter Name","type":"string"},"distance":{"format":"float","title":"Distance","type":"number"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/ChapterDuesProduct":{"id":"components/schemas/ChapterDuesProduct","kind":"json-schema","title":"ChapterDuesProduct","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"},"chapter_id":{"description":"The chapter ID associated with this product","title":"Chapter","type":"string"},"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"},"dues_proration":{"additionalProperties":false,"properties":{"applies_to":{"enum":["both","new members","renewing members"],"title":"Applies To","type":"string"},"april":{"format":"float","title":"April","type":"number"},"august":{"format":"float","title":"August","type":"number"},"december":{"format":"float","title":"December","type":"number"},"february":{"format":"float","title":"February","type":"number"},"january":{"format":"float","title":"January","type":"number"},"july":{"format":"float","title":"July","type":"number"},"june":{"format":"float","title":"June","type":"number"},"march":{"format":"float","title":"March","type":"number"},"may":{"format":"float","title":"May","type":"number"},"november":{"format":"float","title":"November","type":"number"},"october":{"format":"float","title":"October","type":"number"},"september":{"format":"float","title":"September","type":"number"}},"title":"Dues Proration","type":"object"},"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_dues_proration":{"description":"Enable dues proration","title":"Enable Dues Proration","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"},"membership_package_id":{"description":"The membership package associated with this product","title":"Membership Package","type":"string"},"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":["membership-chapter-dues-products"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","chapter_id","coupon_codes","custom_pricing_options","dues_proration","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/ChapterSearchParameters":{"id":"components/schemas/ChapterSearchParameters","kind":"json-schema","title":"ChapterSearchParameters","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"id":{"description":"IDs to search","items":{"type":"string"},"title":"ID","type":"array"},"is_active":{"items":{"type":"boolean"},"title":"Is Active","type":"array"},"name":{"title":"Name","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"type_id":{"description":"Types to search","items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/ChapterSearchResults":{"id":"components/schemas/ChapterSearchResults","kind":"json-schema","title":"ChapterSearchResults","data":{"additionalProperties":false,"properties":{"city":{"description":"City to search","title":"City","type":"string"},"id":{"title":"ID","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"name":{"title":"Name","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"type_id":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/ChapterType":{"id":"components/schemas/ChapterType","kind":"json-schema","title":"ChapterType","data":{"additionalProperties":false,"properties":{"allowed_membership_type_ids":{"description":"The ids of membership types that are allowed to join this chapter","items":{"type":"string"},"minItems":1,"title":"Allowed Membership Types","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this chapter type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this is an active chapter type","title":"Is Active","type":"boolean"},"name":{"description":"The name of the chapter type","title":"Name","type":"string"},"restrict_membership_types":{"description":"When set, only certain membership types can join this chapter","title":"Restrict Membership Types","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":["allowed_membership_type_ids","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Coupon":{"id":"components/schemas/Coupon","kind":"json-schema","title":"Coupon","data":{"additionalProperties":false,"properties":{"add_on_products_discount_info":{"additionalProperties":false,"properties":{"add_on_ids":{"description":"The add ons","items":{"type":"string"},"title":"Add Ons","type":"array"},"add_on_type_ids":{"description":"The add on type IDs","items":{"type":"string"},"title":"Add On Types","type":"array"},"amount":{"format":"float","title":"Amount","type":"number"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"}},"required":["amount"],"title":"Add On Products Discount Info","type":"object"},"applies_to":{"enum":["both","new members","renewing members"],"title":"Applies To","type":"string"},"apply_to_add_on_products":{"description":"This coupon should be applied to membership add on products","title":"Apply To Add On Products","type":"boolean"},"apply_to_chapter_dues":{"description":"This coupon should be applied to chapter dues","title":"Apply To Chapter Dues","type":"boolean"},"apply_to_membership_packages":{"description":"This coupon should be applied to membership packages","title":"Apply To Membership Packages","type":"boolean"},"apply_to_section_dues":{"description":"This coupon should be applied to section dues","title":"Apply To Section Dues","type":"boolean"},"chapter_dues_discount_info":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"chapter_ids":{"description":"The chapter IDs","items":{"type":"string"},"title":"Chapters","type":"array"},"chapter_type_ids":{"description":"The chapter types","items":{"type":"string"},"title":"Chapter Types","type":"array"},"maximum_number_of_chapters":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum # of chapters to apply this discount"},"children":[]}]}]}],"format":"float","title":"Maximum Number Of Chapters","type":"number"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"}},"required":["amount"],"title":"Chapter Dues Discount Info","type":"object"},"code_generation_html":{"description":"HTML you can add into HTML generation for the code","title":"Code Generation Html","type":"string"},"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"},"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"},"membership_package_discount_info":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"},"package_ids":{"description":"The package IDs to which this discount should apply","items":{"type":"string"},"title":"Packages","type":"array"},"type_ids":{"description":"The membership type IDs to which this discount should apply","items":{"type":"string"},"title":"Types","type":"array"}},"required":["amount"],"title":"Membership Package Discount Info","type":"object"},"name":{"description":"The name of the coupon","title":"Name","type":"string"},"section_dues_discount_info":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"maximum_number_of_sections":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum # of sections to apply this discount"},"children":[]}]}]}],"format":"float","title":"Maximum Number Of Sections","type":"number"},"method":{"enum":["amount","percentage"],"title":"Method","type":"string"},"section_ids":{"description":"The section IDs","items":{"type":"string"},"title":"Sections","type":"array"},"section_type_ids":{"description":"The section types","items":{"type":"string"},"title":"Section Types","type":"array"}},"required":["amount"],"title":"Section Dues Discount Info","type":"object"},"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":["add_on_products_discount_info","applies_to","chapter_dues_discount_info","discount_method","discount_product_id","id","membership_package_discount_info","name","section_dues_discount_info","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/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_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_query_type_id":{"title":"Custom Query Type","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"},"downstream_member_options":{"additionalProperties":false,"properties":{"expression":{"description":"The expression to use to determine which expression appear in the directory","oneOf":[{"x-required":true}],"title":"Expression","type":"string"},"filter_type":{"enum":["expression","none","rule"],"title":"Filter Type","type":"string"},"rules":{"title":"Rules","type":"object"}},"required":["filter_type"],"title":"Downstream Member Options","type":"object"},"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"},"show_downstream_members":{"description":"If true, downstream members are included in directory entries","title":"Show Downstream Members","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":{"description":"The type of members being queried","enum":["all","custom","downstream","principal"],"title":"Type","type":"string"}},"required":["custom_directory_entry_template","custom_query_type_id","custom_search_results_template","custom_sort_fields","downstream_member_options","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"],"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/Election":{"id":"components/schemas/Election","kind":"json-schema","title":"Election","data":{"additionalProperties":false,"properties":{"chapter_id":{"title":"Chapter","type":"string"},"close_date":{"description":"The date during which the election should close","format":"date-time","title":"Close Date","type":"string"},"committee_id":{"description":"The committee tied to this election","title":"Committee","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_eligibility_criteria":{"description":"If true, eligibility criteria determines whether this election is available","title":"Enable Eligibility Criteria","type":"boolean"},"id":{"description":"The unique, string identifier of this election","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"measures":{"items":{"additionalProperties":false,"properties":{"description":{"description":"A description of the measure to be approved","title":"Description","type":"string"},"id":{"description":"The ID of the measure","title":"ID","type":"string"},"name":{"description":"The measure","title":"Name","type":"string"}},"required":["description","id","name"],"type":"object"},"type":"array"},"name":{"description":"The name of the election","title":"Name","type":"string"},"open_date":{"description":"The date during which the election should be open","format":"date-time","title":"Open Date","type":"string"},"positions":{"items":{"additionalProperties":false,"properties":{"candidates":{"items":{"additionalProperties":false,"properties":{"contact_id":{"description":"The contact","title":"Contact","type":"string"},"final_vote_count":{"description":"If certified, the final vote count","format":"float","title":"Final Vote Count","type":"number"},"name_on_ballot":{"description":"The name of the candidate, as it appears on the ballot","title":"Name On Ballot","type":"string"}},"required":["contact_id","name_on_ballot"],"type":"object"},"type":"array"},"position_id":{"description":"The position","title":"Position","type":"string"}},"required":["position_id"],"type":"object"},"type":"array"},"section_id":{"title":"Section","type":"string"},"show_in_portal":{"description":"Whether to show this election in the portal","title":"Show In Portal","type":"boolean"},"status":{"enum":["active","cancelled","certified","draft"],"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":{"description":"The type of election","enum":["chapter","national","section"],"title":"Type","type":"string"}},"required":["chapter_id","close_date","committee_id","eligibility_criteria","id","name","open_date","section_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/FindNearestChaptersResult":{"id":"components/schemas/FindNearestChaptersResult","kind":"json-schema","title":"FindNearestChaptersResult","data":{"items":{"additionalProperties":false,"properties":{"address":{"$ref":"#/components/schemas/Address"},"distance":{"format":"float","type":"number"},"id":{"type":"string"},"name":{"type":"string"},"type_id":{"type":"string"}},"type":"object"},"type":"array"}},"components/schemas/GroupApplicationProcess":{"id":"components/schemas/GroupApplicationProcess","kind":"json-schema","title":"GroupApplicationProcess","data":{"additionalProperties":false,"properties":{"account_delegation_process_id":{"description":"If set, the process used for account deletion if the group admin wants to join/renew members they do not own","title":"Account Delegation Process","type":"string"},"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_id":{"description":"The contact form to show to group administrators when they are registering individuals","pattern":"^rolodex-contacts__.*","title":"Contact Form","type":"string"},"contact_role_ids":{"description":"The contact roles that can perform group registration","items":{"type":"string"},"title":"Contact Roles","type":"array"},"description":{"description":"Description to display in the portal","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"},"eligibility_criteria":{"additionalProperties":false,"description":"The criteria for eligibility","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_account_delegation":{"description":"If set, then group administrators can request to be delegates for contacts not tied to their organization","title":"Enable Account Delegation","type":"boolean"},"enable_eligibility_criteria":{"description":"If set, only certain people/organizations can use this process","title":"Enable Eligibility Criteria","type":"boolean"},"enable_tiered_discounts":{"description":"If set, tiered discounts are enabled","title":"Enable Tiered Discounts","type":"boolean"},"group_administrator_confirmation_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":"Group Administrator Confirmation Email","type":"object"},"group_administrator_instructions":{"description":"Instructions to show to group administrators","title":"Group Administrator Instructions","type":"string"},"id":{"description":"The unique, string identifier of this group application process","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this group application process is active","title":"Is Active","type":"boolean"},"membership_package_ids":{"description":"The membership packages that are applicable to this process","items":{"type":"string"},"title":"Membership Packages","type":"array"},"membership_type_ids":{"description":"The membership types that are applicable to this process","items":{"type":"string"},"title":"Membership Types","type":"array"},"name":{"description":"The name of the group application process","title":"Name","type":"string"},"override_checkout_settings":{"description":"Whether or not to override POC settings","title":"Override Checkout Settings","type":"boolean"},"restrict_to_specific_contact_roles":{"description":"If true, only certain contact roles can perform group registration","title":"Restrict To Specific Contact Roles","type":"boolean"},"restrict_to_specific_membership_packages":{"description":"If true, only certain membership packages are applicable to this process","title":"Restrict To Specific Membership Packages","type":"boolean"},"restrict_to_specific_membership_types":{"description":"If true, only certain membership types are applicable to this process","title":"Restrict To Specific Membership Types","type":"boolean"},"send_confirmation_email_to_group_administrator":{"description":"If true, an email is sent to the administrator of the group once registration is complete","title":"Send Confirmation Email To Group Administrator","type":"boolean"},"show_instructions_to_group_administrators":{"description":"If set, group administrators see instructions","title":"Show Instructions To Group Administrators","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"},"tiered_discount_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The amount/percentage to discount","format":"float","title":"Discount Amount","type":"number"},"discount_type":{"enum":["amount","percentage"],"title":"Discount Type","type":"string"},"end_range":{"description":"The end range for this rule (one-based)","format":"float","minimum":1,"title":"End Range","type":"number"},"start_range":{"description":"The starting range for this rule (one-based)","format":"float","minimum":1,"title":"Start Range","type":"number"}},"required":["discount_amount","discount_type","end_range","start_range"],"type":"object"},"minItems":1,"type":"array"}},"required":["account_delegation_process_id","checkout_settings","contact_form_id","contact_role_ids","eligibility_criteria","group_administrator_confirmation_email","group_administrator_instructions","id","membership_package_ids","membership_type_ids","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","tiered_discount_rules"],"type":"object"}},"components/schemas/IdCardTemplate":{"id":"components/schemas/IdCardTemplate","kind":"json-schema","title":"IdCardTemplate","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"html_template":{"description":"An HTML template for the ID card","title":"Html Template","type":"string"},"id":{"description":"The unique, string identifier of this id card template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this id card template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the id card template","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":["html_template","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ListAddOnProductsResponse":{"id":"components/schemas/ListAddOnProductsResponse","kind":"json-schema","title":"ListAddOnProductsResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/AddOnProduct"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListApplicationGroupsResponse":{"id":"components/schemas/ListApplicationGroupsResponse","kind":"json-schema","title":"ListApplicationGroupsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ApplicationGroup"},"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/ListChapterDuesProductsResponse":{"id":"components/schemas/ListChapterDuesProductsResponse","kind":"json-schema","title":"ListChapterDuesProductsResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ChapterDuesProduct"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListElectionsResponse":{"id":"components/schemas/ListElectionsResponse","kind":"json-schema","title":"ListElectionsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Election"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListMembershipsResponse":{"id":"components/schemas/ListMembershipsResponse","kind":"json-schema","title":"ListMembershipsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Membership"},"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/ListSectionDuesProductsResponse":{"id":"components/schemas/ListSectionDuesProductsResponse","kind":"json-schema","title":"ListSectionDuesProductsResponse","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/SectionDuesProduct"},"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/Membership":{"id":"components/schemas/Membership","kind":"json-schema","title":"Membership","data":{"additionalProperties":false,"properties":{"add_on_ids":{"description":"used for reporting, DO NOT UPLOAD DATA HERE","items":{"type":"string"},"title":"Add Ons","type":"array"},"add_on_names":{"description":"Read only: Show the name of the add ons to this membership","title":"Add On Names","type":"string"},"add_ons":{"items":{"additionalProperties":false,"properties":{"add_on_id":{"description":"The add on","title":"Add On","type":"string"},"dues":{"description":"Any dues paid","format":"double","title":"Dues","type":"number"},"order_id":{"description":"The order that created this add on","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"quantity":{"description":"The quantity of add on","format":"float","minimum":1,"title":"Quantity","type":"number"}},"required":["add_on_id"],"type":"object"},"type":"array"},"application_id":{"description":"The last application","title":"Application","type":"string"},"application_process_id":{"description":"The last application process","title":"Application Process","type":"string"},"assigned_memberships":{"description":"Memberships that have been assigned, manually, by organization administrators","items":{"additionalProperties":false,"properties":{"add_on_ids":{"description":"The add ons","items":{"type":"string"},"title":"Add Ons","type":"array"},"chapter_ids":{"description":"The chapter IDs","items":{"type":"string"},"title":"Chapters","type":"array"},"contact_id":{"description":"The contact","title":"Contact","type":"string"},"section_ids":{"description":"The sections IDs","items":{"type":"string"},"title":"Sections","type":"array"}},"required":["contact_id"],"type":"object"},"type":"array"},"bill_method":{"description":"The method this member was billed","enum":["auto renewal order","renewal notice","renewal order"],"title":"Bill Method","type":"string"},"bill_organization":{"description":"Whether or not to bill the organization for this membership","title":"Bill Organization","type":"boolean"},"billed":{"description":"Flag indicated whether the membership has been billed","title":"Billed","type":"boolean"},"certificate_uri":{"description":"A link to an externally created certificate of membership","title":"Certificate Uri","type":"string"},"chapter_ids":{"description":"used for reporting, DO NOT UPLOAD DATA HERE","items":{"type":"string"},"title":"Chapter IDs","type":"array"},"chapter_names":{"description":"Read only: Show the name of the chapters to which a person belongs","title":"Chapter Names","type":"string"},"chapters":{"items":{"additionalProperties":false,"properties":{"chapter_id":{"description":"The chapter ID","title":"Chapter","type":"string"},"dues":{"description":"Any chapter dues paid","format":"double","title":"Dues","type":"number"},"is_new_member":{"title":"Is New Member","type":"boolean"},"join_date":{"description":"The original join date of the chapter","format":"date-time","title":"Join Date","type":"string"},"order_id":{"description":"The order that created this chapter","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"was_renewed":{"description":"This means the last ordered RENEWED the chapter; so cancelling the item should not delete the chapter","title":"Was Renewed","type":"boolean"}},"type":"object"},"type":"array"},"city":{"description":"The member city","title":"City","type":"string"},"contact_id":{"description":"The owner of this membership","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"},"date_last_updated_in_portal":{"description":"The date that this was last updated in the portal","format":"date-time","title":"Date Last Updated In Portal","type":"string"},"date_status":{"description":"Whether the dates have been updated","enum":["not yet updated","updated"],"title":"Date Status","type":"string"},"directory_image_uri":{"description":"The image that appears in the membership directory","title":"Directory Image Uri","type":"string"},"do_not_drop":{"description":"If set, this membership will not be dropped/terminated along lifecycle rules","title":"Do Not Drop","type":"boolean"},"do_not_renew":{"description":"If so, this membership will not renew","title":"Do Not Renew","type":"boolean"},"do_not_show_in_directory":{"description":"If set, the membership is not available in the directory","title":"Do Not Show In Directory","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"},"flowdown_depth":{"description":"If this is a flow down membership, the depth","format":"float","maximum":10,"minimum":1,"title":"Flowdown Depth","type":"number"},"hidden_directory_fields":{"description":"The fields that should not be shown for this member in the directory","items":{"type":"string"},"title":"Hidden Directory Fields","type":"array"},"history":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The history of membership events & activities"},"children":[]}]}]}],"items":{"additionalProperties":false,"properties":{"cancellation_id":{"description":"The cancellation id","title":"Cancellation","type":"string"},"end_date":{"description":"The date this history record is no longer applicable and is superseded by another history record","format":"date-time","title":"End Date","type":"string"},"event":{"enum":["assignment","cancellation","downgrade","drop","flowdown","join","legacy import","merge","reinstatement","renewal","upgrade"],"title":"Event","type":"string"},"is_inherited_membership":{"title":"Is Inherited Membership","type":"boolean"},"new":{"additionalProperties":false,"description":"A snapshot of the membership after the event","properties":{"add_ons":{"items":{"additionalProperties":false,"properties":{"add_on_id":{"description":"The add on","title":"Add On","type":"string"},"dues":{"description":"Any dues paid","format":"double","title":"Dues","type":"number"},"order_id":{"description":"The order that created this add on","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"quantity":{"description":"The quantity of add on","format":"float","minimum":1,"title":"Quantity","type":"number"}},"required":["add_on_id"],"type":"object"},"type":"array"},"chapter_id":{"description":"The chapter ID","title":"Chapter","type":"string"},"chapter_ids":{"description":"All chapter IDs","items":{"type":"string"},"title":"Chapter IDs","type":"array"},"chapters":{"items":{"additionalProperties":false,"properties":{"chapter_id":{"description":"The chapter ID","title":"Chapter","type":"string"},"dues":{"description":"Any chapter dues paid","format":"double","title":"Dues","type":"number"},"is_new_member":{"title":"Is New Member","type":"boolean"},"join_date":{"description":"The original join date of the chapter","format":"date-time","title":"Join Date","type":"string"},"order_id":{"description":"The order that created this chapter","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"was_renewed":{"description":"This means the last ordered RENEWED the chapter; so cancelling the item should not delete the chapter","title":"Was Renewed","type":"boolean"}},"type":"object"},"type":"array"},"expiration_date":{"description":"The date the membership expires","title":"Expiration Date","type":"string"},"is_new":{"description":"Whether or not this is a new membership","title":"Is New","type":"boolean"},"join_date":{"description":"The date the member joined","title":"Join Date","type":"string"},"number":{"description":"The unique membership number","format":"float","title":"Number","type":"number"},"origin":{"enum":["assigned","flowdown","principal"],"title":"Origin","type":"string"},"package_id":{"description":"The package id of the membership","title":"Package","type":"string"},"parent_membership_id":{"description":"The organization which flowed down the membership","title":"Parent Membership","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"},"section_ids":{"items":{"type":"string"},"title":"Section IDs","type":"array"},"sections":{"items":{"additionalProperties":false,"properties":{"dues":{"description":"Any section dues paid","format":"double","title":"Dues","type":"number"},"is_new_member":{"title":"Is New Member","type":"boolean"},"join_date":{"description":"The original join date of the section","format":"date-time","title":"Join Date","type":"string"},"order_id":{"description":"The order that created this section","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"section_id":{"description":"The section ID","title":"Section","type":"string"},"was_renewed":{"description":"This means the last ordered RENEWED the section; so cancelling the item should not delete the section","title":"Was Renewed","type":"boolean"}},"type":"object"},"type":"array"},"status":{"description":"The member status after the event occurred","enum":["active","active without benefits","inactive","suspended"],"title":"Status","type":"string"},"status_reason_id":{"description":"The reason that a member is in the specific status","title":"Status Reason","type":"string"},"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"},"type_id":{"description":"The type of member","title":"Type","type":"string"}},"title":"New","type":"object"},"old":{"additionalProperties":false,"description":"A snapshot of the membership prior to the event","properties":{"add_ons":{"items":{"additionalProperties":false,"properties":{"add_on_id":{"description":"The add on","title":"Add On","type":"string"},"dues":{"description":"Any dues paid","format":"double","title":"Dues","type":"number"},"order_id":{"description":"The order that created this add on","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"quantity":{"description":"The quantity of add on","format":"float","minimum":1,"title":"Quantity","type":"number"}},"required":["add_on_id"],"type":"object"},"type":"array"},"chapter_id":{"description":"The chapter ID","title":"Chapter","type":"string"},"chapter_ids":{"description":"All chapter IDs","items":{"type":"string"},"title":"Chapter IDs","type":"array"},"chapters":{"items":{"additionalProperties":false,"properties":{"chapter_id":{"description":"The chapter ID","title":"Chapter","type":"string"},"dues":{"description":"Any chapter dues paid","format":"double","title":"Dues","type":"number"},"is_new_member":{"title":"Is New Member","type":"boolean"},"join_date":{"description":"The original join date of the chapter","format":"date-time","title":"Join Date","type":"string"},"order_id":{"description":"The order that created this chapter","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"was_renewed":{"description":"This means the last ordered RENEWED the chapter; so cancelling the item should not delete the chapter","title":"Was Renewed","type":"boolean"}},"type":"object"},"type":"array"},"expiration_date":{"description":"The date the membership expires","title":"Expiration Date","type":"string"},"is_new":{"description":"Whether or not this is a new membership","title":"Is New","type":"boolean"},"join_date":{"description":"The date the member joined","title":"Join Date","type":"string"},"number":{"description":"The unique membership number","format":"float","title":"Number","type":"number"},"origin":{"enum":["assigned","flowdown","principal"],"title":"Origin","type":"string"},"package_id":{"description":"The package id of the membership","title":"Package","type":"string"},"parent_membership_id":{"description":"The organization which flowed down the membership","title":"Parent Membership","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"},"section_ids":{"items":{"type":"string"},"title":"Section IDs","type":"array"},"sections":{"items":{"additionalProperties":false,"properties":{"dues":{"description":"Any section dues paid","format":"double","title":"Dues","type":"number"},"is_new_member":{"title":"Is New Member","type":"boolean"},"join_date":{"description":"The original join date of the section","format":"date-time","title":"Join Date","type":"string"},"order_id":{"description":"The order that created this section","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"section_id":{"description":"The section ID","title":"Section","type":"string"},"was_renewed":{"description":"This means the last ordered RENEWED the section; so cancelling the item should not delete the section","title":"Was Renewed","type":"boolean"}},"type":"object"},"type":"array"},"status":{"description":"The member status after the event occurred","enum":["active","active without benefits","inactive","suspended"],"title":"Status","type":"string"},"status_reason_id":{"description":"The reason that a member is in the specific status","title":"Status Reason","type":"string"},"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"},"type_id":{"description":"The type of member","title":"Type","type":"string"}},"title":"Old","type":"object"},"order_id":{"description":"The order that caused the change","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item that caused the change","title":"Order Line Item","type":"string"},"parent_membership_id":{"title":"Parent Membership","type":"string"},"start_date":{"description":"The date of the event","format":"date-time","title":"Start Date","type":"string"}},"required":["event","start_date"],"type":"object"},"type":"array"},"id":{"description":"The unique, string identifier of this membership","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"is_new":{"description":"Whether or not this is a new membership","title":"Is New","type":"boolean"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"join_date":{"description":"The date the member joined","title":"Join Date","type":"string"},"join_or_last_renewal_date":{"description":"The date the member joined OR renewed","title":"Join Or Last Renewal Date","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_bill_date":{"description":"The last time this order was billed","format":"date-time","title":"Last Bill Date","type":"string"},"last_change_affiliation_date":{"description":"The last date a change affiliation was run on this membership","format":"date-time","title":"Last Change Affiliation Date","type":"string"},"last_expired_card_warning":{"description":"The last expired card warning","format":"float","title":"Last Expired Card Warning","type":"number"},"last_expired_card_warning_date":{"description":"The last time a reminder was sent","format":"date-time","title":"Last Expired Card Warning Date","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"last_reminder":{"description":"The last reminder number","format":"float","title":"Last Reminder","type":"number"},"last_reminder_date":{"description":"The last time a reminder was sent","format":"date-time","title":"Last Reminder Date","type":"string"},"master_membership_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The master organizational membership that generates the flowdown; when depth=1 this is the same as the parent, but supports cascading membership"},"children":[]}]}]}],"title":"Master Membership","type":"string"},"master_membership_organization_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The master organization that owns the membership; when depth=1 this is the same as the parent, but supports cascading membership"},"children":[]}]}]}],"title":"Master Membership Organization","type":"string"},"membership_join_date":{"description":"Reporting only; used to avoid collisions","title":"Membership Join Date","type":"string"},"name":{"description":"The member's name","title":"Name","type":"string"},"notes":{"title":"Notes","type":"string"},"number":{"description":"The unique membership 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":"The organizational owner of this membership","title":"Organization","type":"string"},"origin":{"enum":["assigned","flowdown","principal"],"title":"Origin","type":"string"},"overridden_fields":{"description":"Fields that have been changed on this record, and should not be susceptible to flowdown","items":{"type":"string"},"title":"Overridden Fields","type":"array"},"owner_type":{"description":"The type of owner","enum":["contact","organization"],"title":"Owner Type","type":"string"},"package_id":{"description":"The package id of the membership","title":"Package","type":"string"},"parent_membership_id":{"description":"The parent organization","pattern":"organization:.*","title":"Parent Membership","type":"string"},"past_chapter_memberships":{"items":{"additionalProperties":false,"properties":{"chapter_id":{"description":"The chapter","title":"Chapter","type":"string"},"end_date":{"description":"The end of the chapter membership","format":"date","title":"End Date","type":"string"},"join_date":{"description":"The original join date of the chapter","format":"date-time","title":"Join Date","type":"string"},"start_date":{"description":"The beginning of the chapter membership","format":"date","title":"Start Date","type":"string"}},"required":["chapter_id"],"type":"object"},"type":"array"},"past_section_memberships":{"items":{"additionalProperties":false,"properties":{"end_date":{"description":"The end of the section membership","format":"date","title":"End Date","type":"string"},"join_date":{"description":"The original join date of the section","format":"date-time","title":"Join Date","type":"string"},"section_id":{"description":"The section","title":"Section","type":"string"},"start_date":{"description":"The beginning of the section membership","format":"date","title":"Start Date","type":"string"}},"required":["section_id"],"type":"object"},"type":"array"},"primary_chapter_id":{"description":"The chapter ID (used for reporting, DO NOT UPLOAD DATA HERE","title":"Primary Chapter","type":"string"},"referral_contact_id":{"description":"The individual who referred this member","title":"Referral Contact","type":"string"},"reinstatement_date":{"description":"The date the member was last reinstated","title":"Reinstatement Date","type":"string"},"renew_automatically":{"description":"If set, then this membership will automatically renew with the card on file","title":"Renew Automatically","type":"boolean"},"renewal_currency_code":{"description":"The currency code to use for renewal","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":"Renewal Currency Code","type":"string"},"renewal_date":{"description":"The date the member last renewed","title":"Renewal Date","type":"string"},"renewal_payment_card_expiration":{"description":"The date that the renewal payment card expires","format":"date","title":"Renewal Payment Card Expiration","type":"string"},"renewal_payment_info":{"additionalProperties":false,"description":"The renewal payment info","properties":{"card_expiration":{"description":"The expiration date of the card","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account id","title":"Merchant Account","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved","single token"],"title":"Payment Origin","type":"string"},"token":{"description":"For integrated payments, the single token","title":"Token","type":"string"},"type":{"description":"The type of payment","enum":["credit card","electronic check"],"title":"Type","type":"string"}},"required":["payment_origin","type"],"title":"Renewal Payment Info","type":"object"},"section_ids":{"description":"used for reporting, DO NOT UPLOAD DATA HERE","items":{"type":"string"},"title":"Section IDs","type":"array"},"section_names":{"description":"Read only: Show the name of the sections to which a person belongs","title":"Section Names","type":"string"},"sections":{"items":{"additionalProperties":false,"properties":{"dues":{"description":"Any section dues paid","format":"double","title":"Dues","type":"number"},"is_new_member":{"title":"Is New Member","type":"boolean"},"join_date":{"description":"The original join date of the section","format":"date-time","title":"Join Date","type":"string"},"order_id":{"description":"The order that created this section","title":"Order","type":"string"},"order_line_item_id":{"description":"The order item","title":"Order Line Item","type":"string"},"section_id":{"description":"The section ID","title":"Section","type":"string"},"was_renewed":{"description":"This means the last ordered RENEWED the section; so cancelling the item should not delete the section","title":"Was Renewed","type":"boolean"}},"type":"object"},"type":"array"},"state":{"description":"The state","title":"State","type":"string"},"status":{"description":"The member status","enum":["active","active without benefits","inactive","suspended"],"title":"Status","type":"string"},"status_reason_id":{"description":"The reason that a member is in the specific 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"},"type_id":{"description":"The type of member","title":"Type","type":"string"}},"required":["contact_id","flowdown_depth","id","name","number","organization_id","owner_type","package_id","parent_membership_id","renewal_payment_info","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/MembershipSearchParameters":{"id":"components/schemas/MembershipSearchParameters","kind":"json-schema","title":"MembershipSearchParameters","data":{"additionalProperties":false,"properties":{"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"},"join_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Join Date","type":"array"},"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"},"package_id":{"items":{"type":"string"},"title":"Package","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"},"status_reason_id":{"items":{"type":"string"},"title":"Status Reason","type":"array"},"termination_date":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Termination Date","type":"array"},"type_id":{"items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/MembershipSearchResults":{"id":"components/schemas/MembershipSearchResults","kind":"json-schema","title":"MembershipSearchResults","data":{"additionalProperties":false,"properties":{"city":{"title":"City","type":"string"},"email_address":{"title":"Email Address","type":"string"},"expiration_date":{"title":"Expiration Date","type":"string"},"id":{"title":"ID","type":"string"},"is_new":{"title":"Is New","type":"string"},"job_title":{"title":"Job Title","type":"string"},"join_date":{"title":"Join Date","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"origin":{"title":"Origin","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"package_id":{"title":"Package","type":"string"},"renewal_date":{"title":"Renewal Date","type":"string"},"state":{"title":"State","type":"string"},"status":{"title":"Status","type":"string"},"status_reason_id":{"title":"Status Reason","type":"string"},"termination_date":{"title":"Termination Date","type":"string"},"type_id":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/Package":{"id":"components/schemas/Package","kind":"json-schema","title":"Package","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"},"auto_renew_by_default":{"description":"If set, when this membership is created it will be set to auto renewal by default","title":"Auto Renew By Default","type":"boolean"},"available_to":{"description":"DEPRECATED - No longer supported, do not use","enum":["both","new members","renewing members"],"title":"Available To","type":"string"},"bill_organization":{"description":"If set, the organization should be billed for this package","title":"Bill Organization","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"},"chapter_configuration":{"additionalProperties":false,"description":"Allows you to override chapter configuration","properties":{"auto_assignment":{"description":"The auto assignment mode. Suggest guesses the chapter, and assign assigns one without giving the user an option","enum":["assign","off","suggest"],"title":"Auto Assignment","type":"string"},"maximum_number_of_chapters_a_member_can_join":{"description":"The maximum number of chapters a member can join","format":"float","minimum":1,"title":"Maximum Number Of Chapters A Member Can Join","type":"number"},"members_are_required_to_join_a_chapter":{"description":"Whether a member is required to join a a chapter","title":"Members Are Required To Join A Chapter","type":"boolean"},"mode":{"enum":["optional single chapter","required single chapter"],"title":"Mode","type":"string"},"portal_restrictions":{"enum":["members cannot change chapters","members may add chapters","members may add or remove chapters"],"title":"Portal Restrictions","type":"string"}},"required":["maximum_number_of_chapters_a_member_can_join"],"title":"Chapter Configuration","type":"object"},"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"},"description":{"description":"Description for the portal/online store","title":"Description","type":"string"},"display_in_portal_as":{"description":"Override the portal display","title":"Display In Portal As","type":"string"},"display_order":{"format":"float","title":"Display Order","type":"number"},"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"},"does_not_receive_member_benefits":{"description":"If true, buying this package gives you member benefits","title":"Does Not Receive Member Benefits","type":"boolean"},"dues_proration":{"additionalProperties":false,"properties":{"applies_to":{"enum":["both","new members","renewing members"],"title":"Applies To","type":"string"},"april":{"format":"float","title":"April","type":"number"},"august":{"format":"float","title":"August","type":"number"},"december":{"format":"float","title":"December","type":"number"},"february":{"format":"float","title":"February","type":"number"},"january":{"format":"float","title":"January","type":"number"},"july":{"format":"float","title":"July","type":"number"},"june":{"format":"float","title":"June","type":"number"},"march":{"format":"float","title":"March","type":"number"},"may":{"format":"float","title":"May","type":"number"},"november":{"format":"float","title":"November","type":"number"},"october":{"format":"float","title":"October","type":"number"},"september":{"format":"float","title":"September","type":"number"}},"title":"Dues Proration","type":"object"},"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_dues_proration":{"description":"Enable dues proration","title":"Enable Dues Proration","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"},"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":32,"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"},"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_online_store":{"description":"If true, this package is not available in the online store","title":"Hide From Online Store","type":"boolean"},"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"},"membership_type_id":{"description":"The membership type this package is tied to","title":"Membership Type","type":"string"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"organizational_membership_options":{"additionalProperties":false,"properties":{"additional_contact_purchasing_info":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"add_on_product_id":{"description":"The addon product that should be purchased for additional members","title":"Add On Product","type":"string"},"maximum_number_of_additional_contacts":{"description":"If set, puts a limit on how many additional contacts can be purchased","format":"float","title":"Maximum Number Of Additional Contacts","type":"number"}},"required":["add_on_product_id"],"title":"Additional Contact Purchasing Info","type":"object"},"allow_for_purchase_of_additional_contacts":{"description":"If true, organization members can buy additional contacts","title":"Allow For Purchase Of Additional Contacts","type":"boolean"},"maximum_number_of_contacts":{"description":"The maximum number of organizational contacts organizations with this package can have","format":"float","title":"Maximum Number Of Contacts","type":"number"}},"title":"Organizational Membership Options","type":"object"},"override_chapter_configuration":{"description":"Whether or not the chapter configuration is overridden","title":"Override Chapter Configuration","type":"boolean"},"override_section_configuration":{"description":"Whether or not the section configuration is overridden","title":"Override Section Configuration","type":"boolean"},"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"},"product_tags_to_show_at_checkout":{"description":"NOT USED - DEPRECATED","items":{"type":"string"},"title":"Product Tags To Show At Checkout","type":"array"},"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"},"renews_with_id":{"description":"The package that thiscc package should renew with - if null, the package renews with itself","title":"Renews With","type":"string"},"section_configuration":{"additionalProperties":false,"description":"Allows you to override section configuration","properties":{"portal_restrictions":{"enum":["members cannot change sections","members may add or remove sections","members may add sections"],"title":"Portal Restrictions","type":"string"}},"title":"Section Configuration","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"},"suggest_donations":{"description":"Allows you to suggestion donating to specific fundraising products upon checkout","items":{"additionalProperties":false,"properties":{"product_id":{"description":"The fundraising product","title":"Product","type":"string"},"suggested_amount":{"description":"The suggested amount to donate","format":"float","minimum":0,"title":"Suggested Amount","type":"number"}},"required":["product_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"},"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":["membership-packages"],"title":"Type","type":"string"},"update_dates_when":{"enum":["immediately","invoice paid in full","never"],"title":"Update Dates When","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","chapter_configuration","coupon_codes","custom_pricing_options","dues_proration","id","installment_plan_options","membership_type_id","name","price","product_confirmation_email_options","purchase_limits","section_configuration","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PagedApplicationGroupSearchResults":{"id":"components/schemas/PagedApplicationGroupSearchResults","kind":"json-schema","title":"PagedApplicationGroupSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ApplicationGroupSearchResults"},"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/PagedChapterSearchResults":{"id":"components/schemas/PagedChapterSearchResults","kind":"json-schema","title":"PagedChapterSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/ChapterSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedMembershipSearchResults":{"id":"components/schemas/PagedMembershipSearchResults","kind":"json-schema","title":"PagedMembershipSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/MembershipSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedSearchResults":{"id":"components/schemas/PagedSearchResults","kind":"json-schema","title":"PagedSearchResults","data":{"properties":{"Items":{"items":{"type":"object"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedSectionSearchResults":{"id":"components/schemas/PagedSectionSearchResults","kind":"json-schema","title":"PagedSectionSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/SectionSearchResults"},"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":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"}},"components/schemas/PortalPermissionsResult":{"id":"components/schemas/PortalPermissionsResult","kind":"json-schema","title":"PortalPermissionsResult","data":{"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"},"chapter_page_layout_id":{"title":"Chapter Page Layout","type":"string"},"contact_form_id":{"title":"Contact Form","type":"string"},"manage_chapter_committees":{"description":"If set, leaders can manage/change chapter committee positions","title":"Manage Chapter Committees","type":"boolean"},"membership_page_layout_id":{"title":"Membership Page Layout","type":"string"},"permissions":{"description":"A list of permissions by name","items":{"type":"string"},"title":"Permissions","type":"array"},"renew_existing_members":{"description":"If set, leaders can renew existing members","title":"Renew Existing Members","type":"boolean"},"saved_queries":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the saved query","title":"ID","type":"string"},"name":{"description":"The name of the saved query","title":"Name","type":"string"}},"type":"object"},"type":"array"},"sign_up_new_members":{"description":"Applicable chapter leaders can register/create new members","title":"Sign Up New Members","type":"boolean"},"update_chapter_info":{"description":"If true, chapter leader is able to modify chapter information","title":"Update Chapter Info","type":"boolean"},"update_contact_info":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable chapter leaders should be able to update contact information. If set, a contact_form_id must be specified"},"children":[]}]}]}],"title":"Update Contact Info","type":"boolean"},"update_membership_info":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable chapter leaders can update membership profile information. If set, a membership_page_layout_id must be specified"},"children":[]}]}]}],"title":"Update Membership Info","type":"boolean"},"view_chapter_roster":{"description":"If set, the applicable chapter leaders can see the committee roster and view membership information","title":"View Chapter Roster","type":"boolean"}},"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"},"membership_id":{"title":"Membership","type":"string"}},"required":["certificate_template","membership_id"],"type":"object"}},"components/schemas/PreviewEmailRequest":{"id":"components/schemas/PreviewEmailRequest","kind":"json-schema","title":"PreviewEmailRequest","data":{"additionalProperties":false,"properties":{"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"},"membership_id":{"title":"Membership","type":"string"}},"required":["destination_email_address","membership_id"],"type":"object"}},"components/schemas/PreviewGroupApplicationEmailRequest":{"id":"components/schemas/PreviewGroupApplicationEmailRequest","kind":"json-schema","title":"PreviewGroupApplicationEmailRequest","data":{"additionalProperties":false,"properties":{"application_group_id":{"title":"Application Group","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"}},"required":["application_group_id","destination_email_address"],"type":"object"}},"components/schemas/PreviewIdCardRequest":{"id":"components/schemas/PreviewIdCardRequest","kind":"json-schema","title":"PreviewIdCardRequest","data":{"additionalProperties":false,"properties":{"id_card_template":{"title":"Id Card Template","type":"string"},"membership_id":{"title":"Membership","type":"string"}},"required":["id_card_template","membership_id"],"type":"object"}},"components/schemas/PublicMembershipPackagesRequest":{"id":"components/schemas/PublicMembershipPackagesRequest","kind":"json-schema","title":"PublicMembershipPackagesRequest","data":{"properties":{"membership_package_ids":{"items":{"type":"string"},"minItems":0,"title":"Membership Packages","type":"array"},"membership_package_restriction":{"enum":["exclude","include","none"],"title":"Membership Package Restriction","type":"string"},"membership_type_ids":{"items":{"type":"string"},"minItems":0,"title":"Membership Types","type":"array"},"membership_type_restriction":{"enum":["exclude","include","none"],"title":"Membership Type Restriction","type":"string"}},"required":["membership_package_ids","membership_type_ids"],"type":"object"}},"components/schemas/PublicMembershipPackagesResponse":{"id":"components/schemas/PublicMembershipPackagesResponse","kind":"json-schema","title":"PublicMembershipPackagesResponse","data":{"additionalProperties":false,"properties":{"packages":{"items":{"additionalProperties":false,"properties":{"description":{"description":"Description of the package","title":"Description","type":"string"},"display_in_portal_as":{"description":"Portal display","title":"Display In Portal As","type":"string"},"enable_special_prices":{"description":"Whether special prices are used","title":"Enable Special Prices","type":"boolean"},"id":{"description":"ID of the membership package","title":"ID","type":"string"},"member_price":{"description":"Renewal price of the package","format":"float","title":"Member Price","type":"number"},"membership_type_id":{"description":"The membership type","title":"Membership Type","type":"string"},"name":{"description":"Name of the membership package","title":"Name","type":"string"},"price":{"description":"Price of the package","format":"float","title":"Price","type":"number"}},"type":"object"},"type":"array"},"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 membership type","format":"float","title":"Display Order","type":"number"},"id":{"description":"ID of the membership type","title":"ID","type":"string"},"name":{"description":"Name of the membership type","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"}},"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/RelativeDate":{"id":"components/schemas/RelativeDate","kind":"json-schema","title":"RelativeDate","data":{"additionalProperties":false,"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"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"],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"type":"object"}},"components/schemas/ReprocessFlowdownRequest":{"id":"components/schemas/ReprocessFlowdownRequest","kind":"json-schema","title":"ReprocessFlowdownRequest","data":{"additionalProperties":false,"properties":{"notification_email":{"title":"Notification Email","type":"string"}},"type":"object"}},"components/schemas/Section":{"id":"components/schemas/Section","kind":"json-schema","title":"Section","data":{"additionalProperties":false,"properties":{"allowed_membership_type_ids":{"description":"The ids of membership types that are allowed to join this chapter","items":{"type":"string"},"minItems":1,"title":"Allowed Membership Types","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"A description of the section","title":"Description","type":"string"},"enable_dues":{"title":"Enable Dues","type":"boolean"},"enable_new_member_email":{"description":"Allow for new members to receive an email when they join this section","title":"Enable New Member Email","type":"boolean"},"hide_from_portal":{"description":"Whether or not this section is displayed in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this section","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this is an active section","title":"Is Active","type":"boolean"},"name":{"description":"The name of the section","title":"Name","type":"string"},"new_member_email":{"additionalProperties":false,"description":"The new member email","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":"New Member Email","type":"object"},"restrict_membership_types":{"description":"When set, only certain membership types can join this section","title":"Restrict Membership Types","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_id":{"description":"The type of section","title":"Type","type":"string"}},"required":["allowed_membership_type_ids","id","name","new_member_email","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type_id"],"type":"object"}},"components/schemas/SectionDescriptionResult":{"id":"components/schemas/SectionDescriptionResult","kind":"json-schema","title":"SectionDescriptionResult","data":{"items":{"additionalProperties":false,"properties":{"section_type_id":{"type":"string"},"section_type_name":{"type":"string"},"section_type_portal_description":{"type":"string"},"sections":{"items":{"additionalProperties":false,"properties":{"currency_code":{"type":"string"},"dues":{"format":"float","type":"number"},"section_id":{"type":"string"},"section_name":{"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"components/schemas/SectionDuesProduct":{"id":"components/schemas/SectionDuesProduct","kind":"json-schema","title":"SectionDuesProduct","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"},"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"},"dues_proration":{"additionalProperties":false,"properties":{"applies_to":{"enum":["both","new members","renewing members"],"title":"Applies To","type":"string"},"april":{"format":"float","title":"April","type":"number"},"august":{"format":"float","title":"August","type":"number"},"december":{"format":"float","title":"December","type":"number"},"february":{"format":"float","title":"February","type":"number"},"january":{"format":"float","title":"January","type":"number"},"july":{"format":"float","title":"July","type":"number"},"june":{"format":"float","title":"June","type":"number"},"march":{"format":"float","title":"March","type":"number"},"may":{"format":"float","title":"May","type":"number"},"november":{"format":"float","title":"November","type":"number"},"october":{"format":"float","title":"October","type":"number"},"september":{"format":"float","title":"September","type":"number"}},"title":"Dues Proration","type":"object"},"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_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_dues_proration":{"description":"Enable dues proration","title":"Enable Dues Proration","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"},"membership_package_id":{"description":"The membership package associated with this product","title":"Membership Package","type":"string"},"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"},"section_id":{"description":"The section","title":"Section","type":"string"},"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":["membership-section-dues-products"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","dues_proration","id","installment_plan_options","name","price","product_confirmation_email_options","purchase_limits","section_id","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/SectionSearchParameters":{"id":"components/schemas/SectionSearchParameters","kind":"json-schema","title":"SectionSearchParameters","data":{"additionalProperties":false,"properties":{"id":{"description":"IDs to search","items":{"type":"string"},"title":"ID","type":"array"},"is_active":{"items":{"type":"boolean"},"title":"Is Active","type":"array"},"name":{"title":"Name","type":"string"},"type_id":{"description":"Types to search","items":{"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/SectionSearchResults":{"id":"components/schemas/SectionSearchResults","kind":"json-schema","title":"SectionSearchResults","data":{"additionalProperties":false,"properties":{"id":{"title":"ID","type":"string"},"is_active":{"title":"Is Active","type":"boolean"},"name":{"title":"Name","type":"string"},"type_id":{"title":"Type","type":"string"}},"type":"object"}},"components/schemas/SectionType":{"id":"components/schemas/SectionType","kind":"json-schema","title":"SectionType","data":{"additionalProperties":false,"properties":{"allowed_membership_type_ids":{"description":"The ids of membership types that are allowed to join this chapter","items":{"type":"string"},"minItems":1,"title":"Allowed Membership Types","type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"display_in_portal_as":{"description":"Override to display in portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"The order to display these types in the portal","format":"float","title":"Display Order","type":"number"},"id":{"description":"The unique, string identifier of this section type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this is an active section type","title":"Is Active","type":"boolean"},"name":{"description":"The name of the section type","title":"Name","type":"string"},"portal_description":{"description":"Description of this type to be displayed in the portal","title":"Portal Description","type":"string"},"restrict_membership_types":{"description":"When set, only certain membership types can join this section","title":"Restrict Membership Types","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":["allowed_membership_type_ids","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Setting":{"id":"components/schemas/Setting","kind":"json-schema","title":"Setting","data":{"additionalProperties":false,"properties":{"add_on_configuration":{"additionalProperties":false,"properties":{"dues_bundling":{"description":"The mechanism for bundling add on dues","enum":["inline","normal"],"title":"Dues Bundling","type":"string"},"plural_name":{"description":"The term to be used in the portal for add ons (plural)","title":"Plural Name","type":"string"},"portal_restrictions":{"enum":["members cannot change add ons","members may add add-ons","members may add or remove add-ons"],"title":"Portal Restrictions","type":"string"},"singular_name":{"description":"The term to be used in the portal for add ons (singular)","title":"Singular Name","type":"string"}},"title":"Add On Configuration","type":"object"},"allow_committee_members_to_manage_documents":{"description":"When set, committee members are able to manage documents in the portal","title":"Allow Committee Members To Manage Documents","type":"boolean"},"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"},"allow_members_to_update_auto_renewal_settings":{"description":"If true, members have the ability to update auto renewal settings in the portal","title":"Allow Members To Update Auto Renewal Settings","type":"boolean"},"allow_members_to_update_directory_options_in_portal":{"description":"If true, members can update directory information when updating their membership","enum":["disabled","enabled","fields only"],"title":"Allow Members To Update Directory Options In Portal","type":"string"},"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"},"certificate_mode":{"enum":["automatically generate","create manually","disabled"],"title":"Certificate Mode","type":"string"},"certificate_template":{"title":"Certificate Template","type":"string"},"chapter_administration_settings":{"additionalProperties":false,"properties":{"chapter_page_layout_id":{"description":"The page layout to use when updating chapter information","title":"Chapter Page Layout","type":"string"},"contact_form_id":{"description":"The contact form to use when allowing people to update chapter contact info","title":"Contact Form","type":"string"},"membership_page_layout_id":{"description":"The page layout to use when updating membership info","title":"Membership Page Layout","type":"string"},"permissions":{"items":{"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"},"committee_position_ids":{"description":"The committee positions that should match this rule; leave blank for anyone on a chapter committee","items":{"type":"string"},"title":"Committee Positions","type":"array"},"grace_period":{"description":"A grace period (in days) during which chapter leaders still have the permissions specified, even after their membership expires","format":"float","title":"Grace Period","type":"number"},"manage_chapter_committees":{"description":"If set, leaders can manage/change chapter committee positions","title":"Manage Chapter Committees","type":"boolean"},"manage_chapter_documents":{"description":"If set, leaders can view, upload, and delete documents in the file cabinet","title":"Manage Chapter Documents","type":"boolean"},"renew_existing_members":{"description":"If set, leaders can renew existing members","title":"Renew Existing Members","type":"boolean"},"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"},"sign_up_new_members":{"description":"Applicable chapter leaders can register/create new members","title":"Sign Up New Members","type":"boolean"},"update_chapter_info":{"description":"If true, chapter leader is able to modify chapter information","title":"Update Chapter Info","type":"boolean"},"update_contact_info":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable chapter leaders should be able to update contact information. If set, a contact_form_id must be specified"},"children":[]}]}]}],"title":"Update Contact Info","type":"boolean"},"update_membership_info":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable chapter leaders can update membership profile information. If set, a membership_page_layout_id must be specified"},"children":[]}]}]}],"title":"Update Membership Info","type":"boolean"},"view_chapter_roster":{"description":"If set, the applicable chapter leaders can see the committee roster and view membership information","title":"View Chapter Roster","type":"boolean"}},"type":"object"},"type":"array"}},"title":"Chapter Administration Settings","type":"object"},"chapter_center_html_template":{"description":"The template to use for showing chapter information in the portal","title":"Chapter Center Html Template","type":"string"},"chapter_configuration":{"additionalProperties":false,"properties":{"auto_assignment":{"description":"The auto assignment mode. Suggest guesses the chapter, and assign assigns one without giving the user an option","enum":["assign","off","suggest"],"title":"Auto Assignment","type":"string"},"dues_bundling":{"description":"The mechanism for bundling chapter dues","enum":["inline","normal"],"title":"Dues Bundling","type":"string"},"maximum_number_of_chapters_a_member_can_join":{"description":"The maximum number of chapters a member can join - leave blank for an unlimited number of chapters","format":"float","minimum":1,"title":"Maximum Number Of Chapters A Member Can Join","type":"number"},"members_are_required_to_join_a_chapter":{"description":"Whether a member is required to join a a chapter","title":"Members Are Required To Join A Chapter","type":"boolean"},"plural_name":{"description":"The term to be used in the portal for chapters (plural)","title":"Plural Name","type":"string"},"portal_restrictions":{"enum":["members cannot change chapters","members may add chapters","members may add or remove chapters"],"title":"Portal Restrictions","type":"string"},"renewal_pricing_strategy":{"enum":["all renewing members","previous chapter members"],"title":"Renewal Pricing Strategy","type":"string"},"singular_name":{"description":"The term to be used in the portal for chapters (singular)","title":"Singular Name","type":"string"},"update_chapter_when_contact_address_changes":{"description":"If true, the system will listen for changes to contact addresses and try to automatically update their chapter","title":"Update Chapter When Contact Address Changes","type":"boolean"}},"title":"Chapter Configuration","type":"object"},"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"},"conflicting_membership_preference":{"description":"In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used","enum":["organization","principal"],"title":"Conflicting Membership Preference","type":"string"},"contact_role_permissions":{"items":{"additionalProperties":false,"properties":{"manage_membership_privileges":{"description":"Whether the contact role can edit/decide who should receive membership benefits","title":"Manage Membership Privileges","type":"boolean"},"renew_membership":{"description":"Whether the contact role can renew for membership","title":"Renew Membership","type":"boolean"},"role_id":{"description":"The contact role","title":"Role","type":"string"},"sign_up_for_membership":{"description":"Whether the contact role can join as a organizational member","title":"Sign Up For Membership","type":"boolean"},"update_membership_info":{"description":"Whether the contact role can update organization membership info","title":"Update Membership Info","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_generation_logic_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 Application Generation Logic Options","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_order_preprocessing_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 Order Preprocessing Options","type":"object"},"custom_order_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 Order Pricing Options","type":"object"},"default_grace_period":{"description":"The default amount of time after a members expiration during which the are \"in grace\"","format":"float","title":"Default Grace Period","type":"number"},"directory_opt_out_fields":{"description":"The fields that users can opt out of","items":{"type":"string"},"minItems":1,"title":"Directory Opt Out Fields","type":"array"},"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"},"document_settings":{"additionalProperties":false,"properties":{"restrict_management_to_positions":{"description":"If set, only certain committee positions can manage documents","title":"Restrict Management To Positions","type":"boolean"},"restricted_position_ids":{"description":"The positions able to manage documents","items":{"type":"string"},"oneOf":[{"x-required":true}],"title":"Restricted Positions","type":"array"}},"title":"Document Settings","type":"object"},"enable_add_ons":{"description":"Whether or not membership add-ons are enabled","title":"Enable Add Ons","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_chapter_administration":{"description":"If set, chapters are able to administer their members in the portal","title":"Enable Chapter Administration","type":"boolean"},"enable_chapters":{"description":"Whether chapters are enabled","title":"Enable Chapters","type":"boolean"},"enable_custom_application_generation_logic":{"description":"If set, the application generation logic will call a custom lambda function","title":"Enable Custom Application Generation Logic","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_directory_field_level_opt_out":{"description":"If true, users can opt out of the directory specifically","title":"Enable Directory Field Level Opt Out","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_group_membership_applications":{"description":"If set, group membership applications are enbabled","title":"Enable Group Membership Applications","type":"boolean"},"enable_id_cards":{"description":"Support for ID cards that can be downloaded in the portal","title":"Enable Id Cards","type":"boolean"},"enable_no_processes_message":{"description":"Enable a message that shows when a person has no processes available","title":"Enable No Processes Message","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_reinstatement":{"description":"Whether members have the ability to be reinstated after termination","title":"Enable Reinstatement","type":"boolean"},"enable_sections":{"description":"Whether sections are enabled","title":"Enable Sections","type":"boolean"},"enable_split_payments":{"description":"If set, users are allowed to split payments","title":"Enable Split Payments","type":"boolean"},"id_card_settings":{"additionalProperties":false,"properties":{"allow_printing_in_portal":{"description":"Whether or not ID cards can be printed in the portal","title":"Allow Printing In Portal","type":"boolean"},"default_id_card_template_id":{"title":"Default Id Card Template","type":"string"}},"required":["default_id_card_template_id"],"title":"Id Card Settings","type":"object"},"include_flowdown_members_in_kpis":{"description":"Enable adding flowdown memberships in KPIs","title":"Include Flowdown Members In Kpis","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"},"membership_360_screen_id":{"description":"The default 360 screen for membership editing","pattern":"^membership-memberships__.*","title":"Membership 360 Screen","type":"string"},"membership_console_page_layout_id":{"description":"The default page layout for membership editing","pattern":"^membership-memberships__.*","title":"Membership Console Page Layout","type":"string"},"membership_portal_page_layout_id":{"description":"The default page layout for membership editing","pattern":"^membership-memberships__.*","title":"Membership Portal Page Layout","type":"string"},"merchant_account_id":{"description":"The merchant account that the store should use to receive payments","title":"Merchant Account","type":"string"},"no_processes_message":{"description":"Message to show when no processes","title":"No Processes Message","type":"string"},"notes":{"title":"Notes","type":"string"},"override_chapter_center_template":{"description":"If true, a custom template is used for the chapter center","title":"Override Chapter Center Template","type":"boolean"},"override_view_member_template":{"description":"If true, a custom template is used for viewing membership information","title":"Override View Member Template","type":"boolean"},"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"},"reinstatement_options":{"additionalProperties":false,"properties":{"calculate_reinstatement_period_using":{"description":"The mechanism to use to calculate the reinstatement period","enum":["expiration date","termination date"],"title":"Calculate Reinstatement Period Using","type":"string"},"do_not_show_join_processes_during_reinstatement_period":{"description":"If true, a user will not see Join processes during the reinstatement period... only reinstatement processes.","title":"Do Not Show Join Processes During Reinstatement Period","type":"boolean"},"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":{"format":"float","title":"Reinstatement Period","type":"number"}},"title":"Reinstatement Options","type":"object"},"restocking_fee_product_id":{"description":"The ID of the product used for restocking fees","title":"Restocking Fee Product","type":"string"},"section_configuration":{"additionalProperties":false,"properties":{"dues_bundling":{"description":"The mechanism for bundling section dues","enum":["inline","normal"],"title":"Dues Bundling","type":"string"},"plural_name":{"description":"The term to be used in the portal for sections (plural)","title":"Plural Name","type":"string"},"portal_restrictions":{"enum":["members cannot change sections","members may add or remove sections","members may add sections"],"title":"Portal Restrictions","type":"string"},"renewal_pricing_strategy":{"enum":["all renewing members","previous section members"],"title":"Renewal Pricing Strategy","type":"string"},"singular_name":{"description":"The term to be used in the portal for sections (singular)","title":"Singular Name","type":"string"}},"title":"Section Configuration","type":"object"},"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"},"update_expiration_based_on_date_of_payment":{"description":"When set, the membership expiration is set based on the date that the membership was paid vs ordered","title":"Update Expiration Based On Date Of Payment","type":"boolean"},"use_pro_forma_invoices":{"description":"Whether to use pro forma invoices when user elects to pay later","title":"Use Pro Forma Invoices","type":"boolean"},"view_member_html_template":{"description":"The template to use for viewing membership information in the portal","title":"View Member Html Template","type":"string"}},"required":["bank_account_id","business_unit_id","certificate_template","chapter_center_html_template","checkout_donation_options","credit_card_processing_fee_options","custom_application_generation_logic_options","custom_order_preprocessing_options","custom_order_pricing_options","directory_opt_out_fields","id_card_settings","installment_plan_options","merchant_account_id","no_processes_message","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","view_member_html_template"],"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":{"applies_to":{"description":"What status this reason is applicable to","enum":["active","active without benefits","inactive","suspended"],"title":"Applies To","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","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 reason is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the status reason","title":"Name","type":"string"},"priority":{"description":"The priority order, which is how these reasons will be displayed. If the status changes, the first applicable reason based on priority will be set. ","format":"float","title":"Priority","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":["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/Type":{"id":"components/schemas/Type","kind":"json-schema","title":"Type","data":{"additionalProperties":false,"properties":{"certificate_settings":{"additionalProperties":false,"properties":{"certificate_mode":{"enum":["automatically generate","create manually","disabled"],"title":"Certificate Mode","type":"string"},"certificate_template":{"oneOf":[{"x-required":true}],"title":"Certificate Template","type":"string"}},"title":"Certificate Settings","type":"object"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_order_generation_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 Order Generation Options","type":"object"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"display_in_portal_as":{"description":"The name of the type, as displayed in the portal","title":"Display In Portal As","type":"string"},"display_order":{"description":"The order to display types","format":"float","title":"Display Order","type":"number"},"enable_custom_order_generation":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex order logic","title":"Enable Custom Order Generation","type":"boolean"},"enable_flowdown":{"description":"Whether membership flowdown is enabled for this membership type","title":"Enable Flowdown","type":"boolean"},"enable_section_restrictions":{"description":"Whether section requirements are enabled for this membership type","title":"Enable Section Restrictions","type":"boolean"},"flowdown_membership_type_id":{"description":"The membership type for flow down contacts","title":"Flowdown Membership Type","type":"string"},"flowdown_options":{"additionalProperties":false,"properties":{"contact_role_ids":{"description":"The contact roles that should automatically receive membership","items":{"type":"string"},"title":"Contact Roles","type":"array"},"enable_cascading_flowdown":{"description":"Whether membership should cascade down organizations","title":"Enable Cascading Flowdown","type":"boolean"},"organization_type_ids":{"description":"The organization types roles that should automatically receive membership","items":{"type":"string"},"title":"Organization Types","type":"array"}},"title":"Flowdown Options","type":"object"},"hide_from_portal":{"description":"Hidden from portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this membership type","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"id_card_template_id":{"description":"The ID card template for this membership type","title":"Id Card Template","type":"string"},"is_active":{"description":"Whether or not this type is active","title":"Is Active","type":"boolean"},"membership_360_screen_id":{"description":"Override the 360 screen","pattern":"^membership-memberships__.*","title":"Membership 360 Screen","type":"string"},"membership_console_page_layout_id":{"description":"Override the default page layout for membership editing","pattern":"^membership-memberships__.*","title":"Membership Console Page Layout","type":"string"},"membership_portal_page_layout_id":{"description":"Override the default page layout for membership editing","pattern":"^membership-memberships__.*","title":"Membership Portal Page Layout","type":"string"},"name":{"description":"The name of the membership type","title":"Name","type":"string"},"override_certificate_settings":{"description":"If true, the default certificate settings are overridden for this membership","title":"Override Certificate Settings","type":"boolean"},"portal_description":{"description":"The description of this type in the portal","title":"Portal Description","type":"string"},"section_restrictions":{"additionalProperties":false,"properties":{"maximum_number_of_sections":{"description":"The maximum number of overall sections","format":"float","title":"Maximum Number Of Sections","type":"number"},"minimum_number_of_sections":{"description":"The minimum number of overall sections","format":"float","title":"Minimum Number Of Sections","type":"number"},"section_type_restrictions":{"items":{"additionalProperties":false,"properties":{"maximum":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The max # of sections"},"children":[]}]}]}],"format":"float","title":"Maximum","type":"number"},"minimum":{"description":"The minimum number of sections","format":"float","title":"Minimum","type":"number"},"section_type_id":{"description":"The required section type","title":"Section Type","type":"string"}},"type":"object"},"type":"array"}},"title":"Section Restrictions","type":"object"},"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 package when it is in the online store","title":"Universal Shopping Cart Image Uri","type":"string"}},"required":["certificate_settings","custom_order_generation_options","customer_type","id","name","section_restrictions","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"schema_539":{"kind":"json-schema","data":{"type":"string"},"id":"schema_539"},"schema_540":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AddOnProduct"},"type":"array"},"id":"schema_540"},"schema_541":{"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_541"},"schema_542":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PatchDirective"},"type":"array"},"id":"schema_542"},"schema_543":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AddOnType"},"type":"array"},"id":"schema_543"},"schema_544":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AddOn"},"type":"array"},"id":"schema_544"},"schema_545":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AppReferenceType"},"type":"array"},"id":"schema_545"},"schema_546":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ApplicationProcess"},"type":"array"},"id":"schema_546"},"schema_547":{"kind":"json-schema","data":{"type":"string","enum":["contact","organization"]},"id":"schema_547"},"schema_548":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ApplicationStatusReason"},"type":"array"},"id":"schema_548"},"schema_549":{"kind":"json-schema","data":{"type":"object"},"id":"schema_549"},"schema_550":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BillingNotice"},"type":"array"},"id":"schema_550"},"schema_551":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BillingTemplate"},"type":"array"},"id":"schema_551"},"schema_552":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ChangeFee"},"type":"array"},"id":"schema_552"},"schema_553":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ChapterDuesProduct"},"type":"array"},"id":"schema_553"},"schema_554":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ChapterType"},"type":"array"},"id":"schema_554"},"schema_555":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Chapter"},"type":"array"},"id":"schema_555"},"schema_556":{"kind":"json-schema","data":{"type":"number"},"id":"schema_556"},"schema_557":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Coupon"},"type":"array"},"id":"schema_557"},"schema_558":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Directory"},"type":"array"},"id":"schema_558"},"schema_559":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/GroupApplicationProcess"},"type":"array"},"id":"schema_559"},"schema_560":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/IdCardTemplate"},"type":"array"},"id":"schema_560"},"schema_561":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_561"},"schema_562":{"kind":"json-schema","data":{"type":"string","enum":["current","not current","all"]},"id":"schema_562"},"schema_563":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Package"},"type":"array"},"id":"schema_563"},"schema_564":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RecurringBillingRun"},"type":"array"},"id":"schema_564"},"schema_565":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/SectionDuesProduct"},"type":"array"},"id":"schema_565"},"schema_566":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/SectionType"},"type":"array"},"id":"schema_566"},"schema_567":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Section"},"type":"array"},"id":"schema_567"},"schema_568":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/StatusReason"},"type":"array"},"id":"schema_568"},"schema_569":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Type"},"type":"array"},"id":"schema_569"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/membership/membership-v1","isMockServer":true,"description":"Mock server"},{"url":"https://membership.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/membership/membership-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/membership/membership-v1.json?download"},{"url":"/_bundle/apis/membership/membership-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Membership","description":"The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look \nup the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.\n\nLike most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API. \n"}},"baseSlug":"/apis/membership/membership-v1","routesMapping":{}}