Membership

Membership (v1-2025-04-18)

The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.

Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

membership-v1.json

membership-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/

https://membership.api.rhythmsoftware.com/

Add On Products

Operations

Add On Types

Operations

Add Ons

Operations

App Reference Types

Operations

Application Groups

Operations

Application Processes

Operations

Application Status Reasons

Operations

Applications

Operations

Ballots

Operations

Billing Notices

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Change Fees

Operations

Chapter Dues Products

Operations

Chapter Types

Operations

Chapters

Operations

Coupons

Operations

Directories

Operations

Elections

Operations

Creates a new election record that does not already exist.

Request

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.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The election that you would like to be saved.

chapter_idstring(Chapter)required

close_datestring(date-time)(Close Date)required

The date during which the election should close

committee_idstring(Committee)required

The committee tied to this election

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If true, eligibility criteria determines whether this election is available

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this election

measuresArray of objects

namestring(Name)required

The name of the election

open_datestring(date-time)(Open Date)required

The date during which the election should be open

positionsArray of objects

section_idstring(Section)required

show_in_portalboolean(Show In Portal)

Whether to show this election in the portal

statusstring(Status)required

Enum"active""cancelled""certified""draft"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

The type of election

Enum"chapter""national""section"

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "chapter_id": "string",
    "close_date": "2019-08-24T14:15:22Z",
    "committee_id": "string",
    "eligibility_criteria": {
      "advanced_rule_error_message": "string",
      "advanced_rules": {},
      "age_restrictions": {
        "maximum_age": 0.1,
        "minimum_age": 0.1
      },
      "award_options": {
        "award_ids": [
          "string"
        ],
        "award_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "award_recipients": true,
      "by_location": true,
      "certificants": true,
      "certification_options": {
        "logic_operator": "and",
        "program_ids": [
          "string"
        ]
      },
      "committee_member_options": {
        "committee_ids": [
          "string"
        ],
        "committee_position_ids": [
          "string"
        ],
        "committee_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "committee_members": true,
      "custom_logic_options": {
        "lambda_function_id": "string"
      },
      "customer_type": "contact",
      "donor_options": {
        "donor_club_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "donors": true,
      "enable_advanced_rules": true,
      "enable_age_restrictions": true,
      "enable_custom_logic": true,
      "enable_entitlement_restrictions": true,
      "enable_expression": true,
      "enable_organization_restrictions": true,
      "enable_status_restriction": true,
      "entitlement_restrictions": [
        {
          "quantity": 0.1,
          "type_id": "string"
        }
      ],
      "event_registration_options": {
        "event_ids": [
          "string"
        ],
        "logic_operator": "and",
        "registration_category_ids": [
          "string"
        ]
      },
      "event_registrations": true,
      "expression": "string",
      "expression_error_message": "string",
      "location": {
        "countries": [
          "string"
        ],
        "negate_logic": true
      },
      "logic_operator": "and",
      "member_options": {
        "chapter_member_options": {
          "chapter_ids": [
            "string"
          ],
          "chapter_type_ids": [
            "string"
          ],
          "logic_operator": "and"
        },
        "chapter_members": true,
        "member_package_ids": [
          "string"
        ],
        "member_status_reason_ids": [
          "string"
        ],
        "member_statuses": [
          "active"
        ],
        "member_type_ids": [
          "string"
        ],
        "section_member_options": {
          "logic_operator": "and",
          "section_ids": [
            "string"
          ],
          "section_type_ids": [
            "string"
          ]
        },
        "section_members": true
      },
      "members": true,
      "non_members": true,
      "organization_restrictions": {
        "contact_role_ids": [
          "string"
        ],
        "organization_type_ids": [
          "string"
        ]
      },
      "status_restrictions": {
        "0": "string"
      },
      "use_organization_for_eligibility": true
    },
    "enable_eligibility_criteria": true,
    "id": "string",
    "measures": [
      {
        "description": "string",
        "id": "string",
        "name": "string"
      }
    ],
    "name": "string",
    "open_date": "2019-08-24T14:15:22Z",
    "positions": [
      {
        "candidates": [
          {
            "contact_id": "string",
            "final_vote_count": 0.1,
            "name_on_ballot": "string"
          }
        ],
        "position_id": "string"
      }
    ],
    "section_id": "string",
    "show_in_portal": true,
    "status": "active",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "chapter"
  }'

Responses

The election was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

chapter_idstring(Chapter)required

close_datestring(date-time)(Close Date)required

The date during which the election should close

committee_idstring(Committee)required

The committee tied to this election

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If true, eligibility criteria determines whether this election is available

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this election

measuresArray of objects

namestring(Name)required

The name of the election

open_datestring(date-time)(Open Date)required

The date during which the election should be open

positionsArray of objects

section_idstring(Section)required

show_in_portalboolean(Show In Portal)

Whether to show this election in the portal

statusstring(Status)required

Enum"active""cancelled""certified""draft"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

The type of election

Enum"chapter""national""section"

Response

application/json

{
  "chapter_id": "string",
  "close_date": "2019-08-24T14:15:22Z",
  "committee_id": "string",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_eligibility_criteria": true,
  "id": "string",
  "measures": [
    { … }
  ],
  "name": "string",
  "open_date": "2019-08-24T14:15:22Z",
  "positions": [
    { … }
  ],
  "section_id": "string",
  "show_in_portal": true,
  "status": "active",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "chapter"
}

Returns a list of records with the specified chapter_id

Request

Returns a list of records with the specified chapter_id

Path

tenantIdstringrequired

The tenant

chapter_idstringrequired

The chapter_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/chapter/{chapter_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Election)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified committee_id

Request

Returns a list of records with the specified committee_id

Path

tenantIdstringrequired

The tenant

committee_idstringrequired

The committee_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/committee/{committee_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Election)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a list of records with the specified section_id

Request

Returns a list of records with the specified section_id

Path

tenantIdstringrequired

The tenant

section_idstringrequired

The section_id to use to for record lookup

Query

fieldsstring

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

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/section/{section_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

Countinteger

ItemsArray of objects(Election)

LastEvaluatedKeystring

Response

application/json

{
  "Count": 0,
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a election from the system by its ID.

Request

This method will delete a election with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the election to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The election was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a election from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the election to return.

Query

fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The election was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

chapter_idstring(Chapter)required

close_datestring(date-time)(Close Date)required

The date during which the election should close

committee_idstring(Committee)required

The committee tied to this election

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If true, eligibility criteria determines whether this election is available

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this election

measuresArray of objects

namestring(Name)required

The name of the election

open_datestring(date-time)(Open Date)required

The date during which the election should be open

positionsArray of objects

section_idstring(Section)required

show_in_portalboolean(Show In Portal)

Whether to show this election in the portal

statusstring(Status)required

Enum"active""cancelled""certified""draft"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

The type of election

Enum"chapter""national""section"

Response

application/json

{
  "chapter_id": "string",
  "close_date": "2019-08-24T14:15:22Z",
  "committee_id": "string",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_eligibility_criteria": true,
  "id": "string",
  "measures": [
    { … }
  ],
  "name": "string",
  "open_date": "2019-08-24T14:15:22Z",
  "positions": [
    { … }
  ],
  "section_id": "string",
  "show_in_portal": true,
  "status": "active",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "chapter"
}

Partially updates a election with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the election to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The election was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

chapter_idstring(Chapter)required

close_datestring(date-time)(Close Date)required

The date during which the election should close

committee_idstring(Committee)required

The committee tied to this election

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If true, eligibility criteria determines whether this election is available

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this election

measuresArray of objects

namestring(Name)required

The name of the election

open_datestring(date-time)(Open Date)required

The date during which the election should be open

positionsArray of objects

section_idstring(Section)required

show_in_portalboolean(Show In Portal)

Whether to show this election in the portal

statusstring(Status)required

Enum"active""cancelled""certified""draft"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

The type of election

Enum"chapter""national""section"

Response

application/json

{
  "chapter_id": "string",
  "close_date": "2019-08-24T14:15:22Z",
  "committee_id": "string",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_eligibility_criteria": true,
  "id": "string",
  "measures": [
    { … }
  ],
  "name": "string",
  "open_date": "2019-08-24T14:15:22Z",
  "positions": [
    { … }
  ],
  "section_id": "string",
  "show_in_portal": true,
  "status": "active",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "chapter"
}

Updates a election with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the election to update.

Bodyapplication/jsonrequired

The updated election that will be saved.

chapter_idstring(Chapter)required

close_datestring(date-time)(Close Date)required

The date during which the election should close

committee_idstring(Committee)required

The committee tied to this election

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If true, eligibility criteria determines whether this election is available

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this election

measuresArray of objects

namestring(Name)required

The name of the election

open_datestring(date-time)(Open Date)required

The date during which the election should be open

positionsArray of objects

section_idstring(Section)required

show_in_portalboolean(Show In Portal)

Whether to show this election in the portal

statusstring(Status)required

Enum"active""cancelled""certified""draft"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

The type of election

Enum"chapter""national""section"

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/elections/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "chapter_id": "string",
    "close_date": "2019-08-24T14:15:22Z",
    "committee_id": "string",
    "eligibility_criteria": {
      "advanced_rule_error_message": "string",
      "advanced_rules": {},
      "age_restrictions": {
        "maximum_age": 0.1,
        "minimum_age": 0.1
      },
      "award_options": {
        "award_ids": [
          "string"
        ],
        "award_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "award_recipients": true,
      "by_location": true,
      "certificants": true,
      "certification_options": {
        "logic_operator": "and",
        "program_ids": [
          "string"
        ]
      },
      "committee_member_options": {
        "committee_ids": [
          "string"
        ],
        "committee_position_ids": [
          "string"
        ],
        "committee_type_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "committee_members": true,
      "custom_logic_options": {
        "lambda_function_id": "string"
      },
      "customer_type": "contact",
      "donor_options": {
        "donor_club_ids": [
          "string"
        ],
        "logic_operator": "and"
      },
      "donors": true,
      "enable_advanced_rules": true,
      "enable_age_restrictions": true,
      "enable_custom_logic": true,
      "enable_entitlement_restrictions": true,
      "enable_expression": true,
      "enable_organization_restrictions": true,
      "enable_status_restriction": true,
      "entitlement_restrictions": [
        {
          "quantity": 0.1,
          "type_id": "string"
        }
      ],
      "event_registration_options": {
        "event_ids": [
          "string"
        ],
        "logic_operator": "and",
        "registration_category_ids": [
          "string"
        ]
      },
      "event_registrations": true,
      "expression": "string",
      "expression_error_message": "string",
      "location": {
        "countries": [
          "string"
        ],
        "negate_logic": true
      },
      "logic_operator": "and",
      "member_options": {
        "chapter_member_options": {
          "chapter_ids": [
            "string"
          ],
          "chapter_type_ids": [
            "string"
          ],
          "logic_operator": "and"
        },
        "chapter_members": true,
        "member_package_ids": [
          "string"
        ],
        "member_status_reason_ids": [
          "string"
        ],
        "member_statuses": [
          "active"
        ],
        "member_type_ids": [
          "string"
        ],
        "section_member_options": {
          "logic_operator": "and",
          "section_ids": [
            "string"
          ],
          "section_type_ids": [
            "string"
          ]
        },
        "section_members": true
      },
      "members": true,
      "non_members": true,
      "organization_restrictions": {
        "contact_role_ids": [
          "string"
        ],
        "organization_type_ids": [
          "string"
        ]
      },
      "status_restrictions": {
        "0": "string"
      },
      "use_organization_for_eligibility": true
    },
    "enable_eligibility_criteria": true,
    "id": "string",
    "measures": [
      {
        "description": "string",
        "id": "string",
        "name": "string"
      }
    ],
    "name": "string",
    "open_date": "2019-08-24T14:15:22Z",
    "positions": [
      {
        "candidates": [
          {
            "contact_id": "string",
            "final_vote_count": 0.1,
            "name_on_ballot": "string"
          }
        ],
        "position_id": "string"
      }
    ],
    "section_id": "string",
    "show_in_portal": true,
    "status": "active",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "type": "chapter"
  }'

Responses

The election was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

chapter_idstring(Chapter)required

close_datestring(date-time)(Close Date)required

The date during which the election should close

committee_idstring(Committee)required

The committee tied to this election

eligibility_criteriaobject(Eligibility Criteria)required

The criteria to use

eligibility_criteria.advanced_rule_error_messagestring(Advanced Rule Error Message)

The error message to show when the advanced rule fails

eligibility_criteria.advanced_rulesobject(Advanced Rules)

eligibility_criteria.age_restrictionsobject(Age Restrictions)

eligibility_criteria.award_optionsobject(Award Options)

eligibility_criteria.award_recipientsboolean(Award Recipients)

If set, only people who have received awards

eligibility_criteria.by_locationboolean(By Location)

If true, then filter by location

eligibility_criteria.certificantsboolean(Certificants)

If set, only people with specific certifications

eligibility_criteria.certification_optionsCertification Options (object)(Certification Options)

One of:

eligibility_criteria.committee_member_optionsCommittee Member Options (object)(Committee Member Options)

One of:

eligibility_criteria.committee_membersboolean(Committee Members)

If set, active members who belong to a committee can purchase

eligibility_criteria.custom_logic_optionsCustom Logic Options (object)(Custom Logic Options)

One of:

eligibility_criteria.customer_typestring(Customer Type)

Enum"contact""organization"

eligibility_criteria.donor_optionsobject(Donor Options)

eligibility_criteria.donorsboolean(Donors)

If true, only donors

eligibility_criteria.enable_advanced_rulesboolean(Enable Advanced Rules)

Enable advanced JSON rules

eligibility_criteria.enable_age_restrictionsboolean(Enable Age Restrictions)

Age registrations

eligibility_criteria.enable_custom_logicboolean(Enable Custom Logic)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

eligibility_criteria.enable_entitlement_restrictionsboolean(Enable Entitlement Restrictions)

If set, then you must have certain entitlements

eligibility_criteria.enable_expressionboolean(Enable Expression)

Whether or not to enable an expression for evaluation

eligibility_criteria.enable_organization_restrictionsboolean(Enable Organization Restrictions)

If set, you can restrict organizations

eligibility_criteria.enable_status_restrictionboolean(Enable Status Restriction)

If set, you can restrict by status

eligibility_criteria.entitlement_restrictionsArray of objects

eligibility_criteria.event_registration_optionsobject(Event Registration Options)

eligibility_criteria.event_registrationsboolean(Event Registrations)

If set, only people who have registered for events

eligibility_criteria.expressionstring(Expression)

The expression

eligibility_criteria.expression_error_messagestring(Expression Error Message)

The error message to show when the expression fails

eligibility_criteria.locationLocation (object)(Location)

One of:

eligibility_criteria.logic_operatorstring(Logic Operator)

Enum"and""not"

eligibility_criteria.member_optionsMember Options (object)(Member Options)

One of:

eligibility_criteria.membersboolean(Members)

If set, active members can purchase this

eligibility_criteria.non_membersboolean(Non Members)

If set, only nonmembers can purchase

eligibility_criteria.organization_restrictionsobject(Organization Restrictions)

eligibility_criteria.status_restrictionsArray of Status Restrictions (strings)(Status Restrictions)non-empty

The statuses

One of:

The statuses

non-empty

eligibility_criteria.use_organization_for_eligibilityboolean(Use Organization For Eligibility)

If checked, a person's organization is used to check for eligibility, rather than the person themselves

enable_eligibility_criteriaboolean(Enable Eligibility Criteria)

If true, eligibility criteria determines whether this election is available

idstring(ID)^[\w:|-]+$required

The unique, string identifier of this election

measuresArray of objects

namestring(Name)required

The name of the election

open_datestring(date-time)(Open Date)required

The date during which the election should be open

positionsArray of objects

section_idstring(Section)required

show_in_portalboolean(Show In Portal)

Whether to show this election in the portal

statusstring(Status)required

Enum"active""cancelled""certified""draft"

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

typestring(Type)required

The type of election

Enum"chapter""national""section"

Response

application/json

{
  "chapter_id": "string",
  "close_date": "2019-08-24T14:15:22Z",
  "committee_id": "string",
  "eligibility_criteria": {
    "advanced_rule_error_message": "string",
    "advanced_rules": {},
    "age_restrictions": { … },
    "award_options": { … },
    "award_recipients": true,
    "by_location": true,
    "certificants": true,
    "certification_options": { … },
    "committee_member_options": { … },
    "committee_members": true,
    "custom_logic_options": { … },
    "customer_type": "contact",
    "donor_options": { … },
    "donors": true,
    "enable_advanced_rules": true,
    "enable_age_restrictions": true,
    "enable_custom_logic": true,
    "enable_entitlement_restrictions": true,
    "enable_expression": true,
    "enable_organization_restrictions": true,
    "enable_status_restriction": true,
    "entitlement_restrictions": [ … ],
    "event_registration_options": { … },
    "event_registrations": true,
    "expression": "string",
    "expression_error_message": "string",
    "location": { … },
    "logic_operator": "and",
    "member_options": { … },
    "members": true,
    "non_members": true,
    "organization_restrictions": { … },
    "status_restrictions": { … },
    "use_organization_for_eligibility": true
  },
  "enable_eligibility_criteria": true,
  "id": "string",
  "measures": [
    { … }
  ],
  "name": "string",
  "open_date": "2019-08-24T14:15:22Z",
  "positions": [
    { … }
  ],
  "section_id": "string",
  "show_in_portal": true,
  "status": "active",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_bulk_data_operation_id": "string",
  "sys_last_bulk_data_operation_sys_version": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "type": "chapter"
}

Group Application Processes

Operations

Id Card Templates

Operations

Memberships

Operations

Packages

Operations

Query Definitions

Operations

Recurring Billing Runs

Operations

Section Dues Products

Operations

Section Types

Operations

Sections

Operations

Settings

Operations

Statistics

Operations

Status Reasons

Operations

Types

Operations

Membership (v1-2025-04-18)

Add On Products

Add On Types

Add Ons

App Reference Types

Application Groups

Application Processes

Application Status Reasons

Applications

Ballots

Billing Notices

Billing Run Actions

Billing Runs

Billing Templates

Change Fees

Chapter Dues Products

Chapter Types

Chapters

Coupons

Directories

Elections

Creates a new election record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Returns a list of records with the specified chapter_id

Request

Responses

Was this helpful?

Returns a list of records with the specified committee_id

Request

Responses

Was this helpful?

Returns a list of records with the specified section_id

Request

Responses

Was this helpful?

Returns a election from the system by its ID.

Request

Responses

Was this helpful?

Returns a election from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a election with the specified ID.

Request

Responses

Was this helpful?

Updates a election with the specified ID.

RequestExpand all

Responses

Was this helpful?

Group Application Processes

Id Card Templates

Memberships

Packages

Query Definitions

Recurring Billing Runs

Section Dues Products

Section Types

Sections

Settings

Statistics

Status Reasons

Types

Request

Request