Applications

Returns a application from the system by its ID.

This method will look up a application 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 application 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 application was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The application could not be found.

429Limit exceeded... unable to retrieve application based on tenant limits.

500General server error.

get/applications/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a application with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application to update.

Request Body schema: application/json

The updated application that will be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this application
type required	string (Type) Enum: "join" "renewal" "reinstatement" "change affiliations"
process_id required	string (Process) The application process used
owner_type required	string (Owner Type) The type of owner Enum: "contact" "organization"
contact_id required	string (Contact) The owner of this membership
organization_id required	string (Organization) The organizational owner of this membership
review_status	string (Review Status) The review status of this application Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change	string <date-time> (Last Review Status Change) The date that the review status was last changed
pending_console_review	boolean (Pending Console Review) If true, then this record has been reviewed and now needs action by the staff
submission_space_id	string (Submission Space) The submission space to which this object belongs
override_bucket_assignment	boolean (Override Bucket Assignment) If set, the bucket is not calculated automatically, and instead manually assigned
round_id	string (Round) The review round
bucket_id required	string (Bucket) The review bucket
average_score	number <float> (Average Score) The average score for this submission in the most recent round
total_score	number <float> (Total Score) The total score for this submission in the most recent round
reviewer_recommendation	string (Reviewer Recommendation) Aggregate recommendation across all reviewers
group_order	number <float> (Group Order) The order of the application in the group
application_group_id	string (Application Group) The associated application group
group_application_process_id	string (Group Application Process) The associated application group application
renew_automatically	boolean (Renew Automatically) If set, then this membership will automatically renew with the card on file
name required	string (Name) The name on the application
date	string <date-time> (Date) The date of the application
order_id	string (Order) The order id
order_line_item_id	string (Order Line Item) The order line item id
status required	string (Status) The membership application status Enum: "not yet submitted" "under review" "approved" "rejected"
status_reason_id	string (Status Reason) The reason that a membership application is in the specific status
	Array of objects
membership_package_id	string (Membership Package) The membership package
membership_type_id	string (Membership Type) The membership type
chapter_id	string (Chapter) The chapter ID
additional_chapter_ids	Array of strings (Additional Chapters) Additional chapter IDs
section_ids	Array of strings (Sections)
	Array of objects
corporate_member_ids	Array of strings (Corporate Members) The individuals that should receive the corporate membership
referral_contact_id	string (Referral Contact) The individual who referred this member
do_not_show_in_directory	boolean (Do Not Show In Directory) Whether or not this membership should be hidden from the directory
do_not_renew	boolean (Do Not Renew) Do not attempt to automatically renew this membership
notes	string (Notes) Notes
hidden_directory_fields	Array of strings (Hidden Directory Fields) The fields that should not be shown for this member in the directory
	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_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
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_has_files_in_s3	boolean (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_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
	Array of objects

Responses

200The application was updated successfully.

400The application supplied was not valid.

401Unauthorized.

403Forbidden.

404The application could not be found.

409The application could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve application based on tenant limits.

500General server error.

put/applications/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a application with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application 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 application was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The application could not be found.

409The application could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve application based on tenant limits.

500General server error.

patch/applications/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a application from the system by its ID.

This method will delete a application with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the application to delete.

Responses

200The application was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The application could not be found.

409The application could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete application based on tenant limits.

500General server error.

delete/applications/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Generates an order from a membership application

This method will examine a membership application and generate an appropriate order

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The application to generate an order

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this application
type required	string (Type) Enum: "join" "renewal" "reinstatement" "change affiliations"
process_id required	string (Process) The application process used
owner_type required	string (Owner Type) The type of owner Enum: "contact" "organization"
contact_id required	string (Contact) The owner of this membership
organization_id required	string (Organization) The organizational owner of this membership
review_status	string (Review Status) The review status of this application Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change	string <date-time> (Last Review Status Change) The date that the review status was last changed
pending_console_review	boolean (Pending Console Review) If true, then this record has been reviewed and now needs action by the staff
submission_space_id	string (Submission Space) The submission space to which this object belongs
override_bucket_assignment	boolean (Override Bucket Assignment) If set, the bucket is not calculated automatically, and instead manually assigned
round_id	string (Round) The review round
bucket_id required	string (Bucket) The review bucket
average_score	number <float> (Average Score) The average score for this submission in the most recent round
total_score	number <float> (Total Score) The total score for this submission in the most recent round
reviewer_recommendation	string (Reviewer Recommendation) Aggregate recommendation across all reviewers
group_order	number <float> (Group Order) The order of the application in the group
application_group_id	string (Application Group) The associated application group
group_application_process_id	string (Group Application Process) The associated application group application
renew_automatically	boolean (Renew Automatically) If set, then this membership will automatically renew with the card on file
name required	string (Name) The name on the application
date	string <date-time> (Date) The date of the application
order_id	string (Order) The order id
order_line_item_id	string (Order Line Item) The order line item id
status required	string (Status) The membership application status Enum: "not yet submitted" "under review" "approved" "rejected"
status_reason_id	string (Status Reason) The reason that a membership application is in the specific status
	Array of objects
membership_package_id	string (Membership Package) The membership package
membership_type_id	string (Membership Type) The membership type
chapter_id	string (Chapter) The chapter ID
additional_chapter_ids	Array of strings (Additional Chapters) Additional chapter IDs
section_ids	Array of strings (Sections)
	Array of objects
corporate_member_ids	Array of strings (Corporate Members) The individuals that should receive the corporate membership
referral_contact_id	string (Referral Contact) The individual who referred this member
do_not_show_in_directory	boolean (Do Not Show In Directory) Whether or not this membership should be hidden from the directory
do_not_renew	boolean (Do Not Renew) Do not attempt to automatically renew this membership
notes	string (Notes) Notes
hidden_directory_fields	Array of strings (Hidden Directory Fields) The fields that should not be shown for this member in the directory
	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_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
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_has_files_in_s3	boolean (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_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
	Array of objects

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/applications/{tenantId}/generateOrder

Request samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{ }

Generates an group order from a membership application

This method will examine a membership application and generate an appropriate order

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
groupId required	string The ID of the group

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/applications/{tenantId}/generateGroupOrder/{groupId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/generateGroupOrder/:groupId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{ }

Generates an application for a contact or organization

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
processId required	string The process id
ownerType required	string The contact or organization type Enum: "contact" "organization"
id required	string The contact or organization type

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

429Limit exceeded... unable to add order based on tenant limits.

500General server error

post/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/generateApplication/:processId/:ownerType/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Searches for applications using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The application that you would like to be saved.

id	Array of strings (ID) IDs to search
owner_type	string (Owner Type)
name	string (Name)
status	Array of strings (Status)
status_reason_id	Array of strings (Status Reason)
type	Array of strings (Type)
membership_type_id	Array of strings (Membership Type)
membership_package_id	Array of strings (Membership Package)
date	Array of strings <date-time> (Date) 2 items

Responses

200The application search was saved successfully.

400The application you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The application could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add application based on tenant limits.

500General server error.

post/applications/{tenantId}/search

Request samples

application/json

{"id": ["string"
],
"owner_type": "string",
"name": "string",
"status": ["string"
],
"status_reason_id": ["string"
],
"type": ["string"
],
"membership_type_id": ["string"
],
"membership_package_id": ["string"
],
"date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
]
}

Response samples

application/json

{"Items": [{"id": "string",
"name": "string",
"owner_type": "string",
"status": "string",
"status_reason_id": "string",
"type": "string",
"membership_type_id": "string",
"membership_package_id": "string",
"date": "string"
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified contact_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
contact_id required	string The contact_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/applications/{tenantId}/contact/{contact_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified organization_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
organization_id required	string The organization_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/applications/{tenantId}/organization/{organization_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/organization/:organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified application_group_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
application_group_id required	string The application_group_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

get/applications/{tenantId}/applicationGroup/{application_group_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/applications/:tenantId/applicationGroup/:application_group_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
],
"LastEvaluatedKey": "string"
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The application could not be found.

429Limit exceeded... unable to retrieve application based on tenant limits.

500General server error.

post/applications/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}

Creates a new application record that does not already exist.

This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The application that you would like to be saved.

id required	string (ID) /^[\w\|-]+$/ The unique, string identifier of this application
type required	string (Type) Enum: "join" "renewal" "reinstatement" "change affiliations"
process_id required	string (Process) The application process used
owner_type required	string (Owner Type) The type of owner Enum: "contact" "organization"
contact_id required	string (Contact) The owner of this membership
organization_id required	string (Organization) The organizational owner of this membership
review_status	string (Review Status) The review status of this application Enum: "pending review" "alternate" "accepted" "declined"
last_review_status_change	string <date-time> (Last Review Status Change) The date that the review status was last changed
pending_console_review	boolean (Pending Console Review) If true, then this record has been reviewed and now needs action by the staff
submission_space_id	string (Submission Space) The submission space to which this object belongs
override_bucket_assignment	boolean (Override Bucket Assignment) If set, the bucket is not calculated automatically, and instead manually assigned
round_id	string (Round) The review round
bucket_id required	string (Bucket) The review bucket
average_score	number <float> (Average Score) The average score for this submission in the most recent round
total_score	number <float> (Total Score) The total score for this submission in the most recent round
reviewer_recommendation	string (Reviewer Recommendation) Aggregate recommendation across all reviewers
group_order	number <float> (Group Order) The order of the application in the group
application_group_id	string (Application Group) The associated application group
group_application_process_id	string (Group Application Process) The associated application group application
renew_automatically	boolean (Renew Automatically) If set, then this membership will automatically renew with the card on file
name required	string (Name) The name on the application
date	string <date-time> (Date) The date of the application
order_id	string (Order) The order id
order_line_item_id	string (Order Line Item) The order line item id
status required	string (Status) The membership application status Enum: "not yet submitted" "under review" "approved" "rejected"
status_reason_id	string (Status Reason) The reason that a membership application is in the specific status
	Array of objects
membership_package_id	string (Membership Package) The membership package
membership_type_id	string (Membership Type) The membership type
chapter_id	string (Chapter) The chapter ID
additional_chapter_ids	Array of strings (Additional Chapters) Additional chapter IDs
section_ids	Array of strings (Sections)
	Array of objects
corporate_member_ids	Array of strings (Corporate Members) The individuals that should receive the corporate membership
referral_contact_id	string (Referral Contact) The individual who referred this member
do_not_show_in_directory	boolean (Do Not Show In Directory) Whether or not this membership should be hidden from the directory
do_not_renew	boolean (Do Not Renew) Do not attempt to automatically renew this membership
notes	string (Notes) Notes
hidden_directory_fields	Array of strings (Hidden Directory Fields) The fields that should not be shown for this member in the directory
	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_last_bulk_data_operation_id	string (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_version	string (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_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
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_has_files_in_s3	boolean (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_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
	Array of objects

Responses

200The application was saved successfully.

400The application you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The application could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add application based on tenant limits.

500General server error.

post/applications/{tenantId}

Request samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"type": "join",
"process_id": "string",
"owner_type": "contact",
"contact_id": "string",
"organization_id": "string",
"review_status": "pending review",
"last_review_status_change": "2019-08-24T14:15:22Z",
"pending_console_review": true,
"submission_space_id": "string",
"override_bucket_assignment": true,
"round_id": "string",
"bucket_id": "string",
"average_score": 0,
"total_score": 0,
"reviewer_recommendation": "string",
"group_order": 0,
"application_group_id": "string",
"group_application_process_id": "string",
"renew_automatically": true,
"name": "string",
"date": "2019-08-24T14:15:22Z",
"order_id": "string",
"order_line_item_id": "string",
"status": "not yet submitted",
"status_reason_id": "string",
"assigned_contacts": [{"type": "existing",
"contact_id": "string",
"new_contact_info": { },
"chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_on_ids": ["string"
]
}
],
"membership_package_id": "string",
"membership_type_id": "string",
"chapter_id": "string",
"additional_chapter_ids": ["string"
],
"section_ids": ["string"
],
"add_ons": [{"add_on_id": "string",
"quantity": 1
}
],
"corporate_member_ids": ["string"
],
"referral_contact_id": "string",
"do_not_show_in_directory": true,
"do_not_renew": true,
"notes": "string",
"hidden_directory_fields": ["string"
],
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"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_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}