Types

Types

Creates a new type record that does not already exist.

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.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The type that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this membership type

name
required
string (Name)

The name of the membership type

customer_type
required
string (Customer Type)
Enum: "contact" "organization"
display_in_portal_as
string (Display In Portal As)

The name of the type, as displayed in the portal

portal_description
string (Portal Description)

The description of this type in the portal

membership_console_page_layout_id
string (Membership Console Page Layout) /^membership-memberships__.*/

Override the default page layout for membership editing

membership_portal_page_layout_id
string (Membership Portal Page Layout) /^membership-memberships__.*/

Override the default page layout for membership editing

membership_360_screen_id
string (Membership 360 Screen) /^membership-memberships__.*/

Override the 360 screen

flowdown_membership_type_id
string (Flowdown Membership Type)

The membership type for flow down contacts

enable_flowdown
boolean (Enable Flowdown)

Whether membership flowdown is enabled for this membership type

object (Flowdown Options)
override_certificate_settings
boolean (Override Certificate Settings)

If true, the default certificate settings are overridden for this membership

required
object (Certificate Settings)
enable_section_restrictions
boolean (Enable Section Restrictions)

Whether section requirements are enabled for this membership type

required
object (Section Restrictions)
id_card_template_id
string (Id Card Template)

The ID card template for this membership type

hide_from_portal
boolean (Hide From Portal)

Hidden from portal

display_order
number <float> (Display Order)

The order to display types

is_active
boolean (Is Active)

Whether or not this type is active

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Responses
200The type was saved successfully.
400The type you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The type could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add type based on tenant limits.
500General server error.
post/types/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "customer_type": "contact",
  • "display_in_portal_as": "string",
  • "portal_description": "string",
  • "membership_console_page_layout_id": "string",
  • "membership_portal_page_layout_id": "string",
  • "membership_360_screen_id": "string",
  • "flowdown_membership_type_id": "string",
  • "enable_flowdown": true,
  • "flowdown_options": {
    },
  • "override_certificate_settings": true,
  • "certificate_settings": {
    },
  • "enable_section_restrictions": true,
  • "section_restrictions": {
    },
  • "id_card_template_id": "string",
  • "hide_from_portal": true,
  • "display_order": 0,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "customer_type": "contact",
  • "display_in_portal_as": "string",
  • "portal_description": "string",
  • "membership_console_page_layout_id": "string",
  • "membership_portal_page_layout_id": "string",
  • "membership_360_screen_id": "string",
  • "flowdown_membership_type_id": "string",
  • "enable_flowdown": true,
  • "flowdown_options": {
    },
  • "override_certificate_settings": true,
  • "certificate_settings": {
    },
  • "enable_section_restrictions": true,
  • "section_restrictions": {
    },
  • "id_card_template_id": "string",
  • "hide_from_portal": true,
  • "display_order": 0,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Gets all of the types in the system.

This method will scan all types and and return them to the caller.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The typeswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/types/{tenantId}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/types/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a type from the system by its ID.

This method will look up a type by the specified ID and return it back.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the type to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The type was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The type could not be found.
429Limit exceeded... unable to retrieve type based on tenant limits.
500General server error.
get/types/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/types/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "customer_type": "contact",
  • "display_in_portal_as": "string",
  • "portal_description": "string",
  • "membership_console_page_layout_id": "string",
  • "membership_portal_page_layout_id": "string",
  • "membership_360_screen_id": "string",
  • "flowdown_membership_type_id": "string",
  • "enable_flowdown": true,
  • "flowdown_options": {
    },
  • "override_certificate_settings": true,
  • "certificate_settings": {
    },
  • "enable_section_restrictions": true,
  • "section_restrictions": {
    },
  • "id_card_template_id": "string",
  • "hide_from_portal": true,
  • "display_order": 0,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Updates a type with the specified ID.

This method will update an existing type with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the type to update.

Request Body schema: application/json

The updated type that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this membership type

name
required
string (Name)

The name of the membership type

customer_type
required
string (Customer Type)
Enum: "contact" "organization"
display_in_portal_as
string (Display In Portal As)

The name of the type, as displayed in the portal

portal_description
string (Portal Description)

The description of this type in the portal

membership_console_page_layout_id
string (Membership Console Page Layout) /^membership-memberships__.*/

Override the default page layout for membership editing

membership_portal_page_layout_id
string (Membership Portal Page Layout) /^membership-memberships__.*/

Override the default page layout for membership editing

membership_360_screen_id
string (Membership 360 Screen) /^membership-memberships__.*/

Override the 360 screen

flowdown_membership_type_id
string (Flowdown Membership Type)

The membership type for flow down contacts

enable_flowdown
boolean (Enable Flowdown)

Whether membership flowdown is enabled for this membership type

object (Flowdown Options)
override_certificate_settings
boolean (Override Certificate Settings)

If true, the default certificate settings are overridden for this membership

required
object (Certificate Settings)
enable_section_restrictions
boolean (Enable Section Restrictions)

Whether section requirements are enabled for this membership type

required
object (Section Restrictions)
id_card_template_id
string (Id Card Template)

The ID card template for this membership type

hide_from_portal
boolean (Hide From Portal)

Hidden from portal

display_order
number <float> (Display Order)

The order to display types

is_active
boolean (Is Active)

Whether or not this type is active

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Responses
200The type was updated successfully.
400The type supplied was not valid.
401Unauthorized.
403Forbidden.
404The type could not be found.
409The type could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve type based on tenant limits.
500General server error.
put/types/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "customer_type": "contact",
  • "display_in_portal_as": "string",
  • "portal_description": "string",
  • "membership_console_page_layout_id": "string",
  • "membership_portal_page_layout_id": "string",
  • "membership_360_screen_id": "string",
  • "flowdown_membership_type_id": "string",
  • "enable_flowdown": true,
  • "flowdown_options": {
    },
  • "override_certificate_settings": true,
  • "certificate_settings": {
    },
  • "enable_section_restrictions": true,
  • "section_restrictions": {
    },
  • "id_card_template_id": "string",
  • "hide_from_portal": true,
  • "display_order": 0,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "customer_type": "contact",
  • "display_in_portal_as": "string",
  • "portal_description": "string",
  • "membership_console_page_layout_id": "string",
  • "membership_portal_page_layout_id": "string",
  • "membership_360_screen_id": "string",
  • "flowdown_membership_type_id": "string",
  • "enable_flowdown": true,
  • "flowdown_options": {
    },
  • "override_certificate_settings": true,
  • "certificate_settings": {
    },
  • "enable_section_restrictions": true,
  • "section_restrictions": {
    },
  • "id_card_template_id": "string",
  • "hide_from_portal": true,
  • "display_order": 0,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Partially updates a type with the specified ID.

This method will patch an existing type with the specified ID, using the HTTP PATCH specification.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the type to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The type was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The type could not be found.
409The type could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve type based on tenant limits.
500General server error.
patch/types/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "customer_type": "contact",
  • "display_in_portal_as": "string",
  • "portal_description": "string",
  • "membership_console_page_layout_id": "string",
  • "membership_portal_page_layout_id": "string",
  • "membership_360_screen_id": "string",
  • "flowdown_membership_type_id": "string",
  • "enable_flowdown": true,
  • "flowdown_options": {
    },
  • "override_certificate_settings": true,
  • "certificate_settings": {
    },
  • "enable_section_restrictions": true,
  • "section_restrictions": {
    },
  • "id_card_template_id": "string",
  • "hide_from_portal": true,
  • "display_order": 0,
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Returns a type from the system by its ID.

This method will delete a type with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the type to delete.

Responses
200The type was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The type could not be found.
409The type could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete type based on tenant limits.
500General server error.
delete/types/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://membership.api.rhythmsoftware.com/types/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"