# Awards (Awards & Nominations) Service providing access to Awards (Awards & Nominations) resources and features Version: v1-2025-04-18 ## Servers ``` https://awards.api.rhythmsoftware.com ``` ## Security ### knox-authorizer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description - [Awards (Awards & Nominations)](https://docs.api.rhythmsoftware.com/_bundle/apis/awards/awards-v1.yaml) ## Application Fees - [POST /applicationFees/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/createapplicationfee.md): This method will auto-generate an ID and create a new application fee. If an ID is specified for the application fee, an error will be thrown. - [GET /applicationFees/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/listfeesbyawardid.md): Returns a list of records with the specified award_id - [POST /applicationFees/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /applicationFees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/deleteapplicationfee.md): This method will delete a application fee with the specified ID. - [GET /applicationFees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/getapplicationfee.md): This method will look up a application fee by the specified ID and return it back. - [PATCH /applicationFees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/patchapplicationfee.md): This method will patch an existing application fee with the specified ID, using the HTTP PATCH specification. - [PUT /applicationFees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-fees/updateapplicationfee.md): This method will update an existing application fee with the specified ID. ## Application Processes - [POST /applicationProcesses/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/createapplicationprocess.md): This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown. - [GET /applicationProcesses/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/listprocessesbyawardid.md): Returns a list of records with the specified award_id - [POST /applicationProcesses/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /applicationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{contactOrOrganizationId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/geteligibleprocesses.md) - [DELETE /applicationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/deleteapplicationprocess.md): This method will delete a application process with the specified ID. - [GET /applicationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/getapplicationprocess.md): This method will look up a application process by the specified ID and return it back. - [PATCH /applicationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/patchapplicationprocess.md): This method will patch an existing application process with the specified ID, using the HTTP PATCH specification. - [PUT /applicationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-processes/updateapplicationprocess.md): This method will update an existing application process with the specified ID. ## Application Status Reasons - [GET /applicationStatusReasons/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/listapplicationstatusreasons.md): This method will scan all application status reasons and and return them to the caller. - [POST /applicationStatusReasons/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/createapplicationstatusreason.md): This method will auto-generate an ID and create a new application status reason. If an ID is specified for the application status reason, an error will be thrown. - [POST /applicationStatusReasons/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /applicationStatusReasons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/deleteapplicationstatusreason.md): This method will delete a application status reason with the specified ID. - [GET /applicationStatusReasons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/getapplicationstatusreason.md): This method will look up a application status reason by the specified ID and return it back. - [PATCH /applicationStatusReasons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/patchapplicationstatusreason.md): This method will patch an existing application status reason with the specified ID, using the HTTP PATCH specification. - [PUT /applicationStatusReasons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/application-status-reasons/updateapplicationstatusreason.md): This method will update an existing application status reason with the specified ID. ## Applications - [POST /applications/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/createapplication.md): 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. - [GET /applications/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/listapplicationsbyawardid.md): Returns a list of records with the specified award_id - [POST /applications/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /applications/{tenantId}/contact/{ownerType}/{contactOrOrgId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/listapplicationsbyownertypecontactororgid.md): Returns a list of records with the specified owner_type and id - [POST /applications/{tenantId}/generateOrder](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/generateorder.md): This method will examine an awards application and generate an appropriate order - [POST /applications/{tenantId}/previewEmail](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/previewemail.md): Sends out a preview of the CRC notification email - [POST /applications/{tenantId}/process](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/processapplication.md): Sends out a preview of the CRC notification email - [POST /applications/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/searchforapplications.md): Searches for applications using predefined parameters - [DELETE /applications/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/deleteapplication.md): This method will delete a application with the specified ID. - [GET /applications/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/getapplication.md): This method will look up a application by the specified ID and return it back. - [PATCH /applications/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/patchapplication.md): This method will patch an existing application with the specified ID, using the HTTP PATCH specification. - [PUT /applications/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/applications/updateapplication.md): This method will update an existing application with the specified ID. ## Awards - [GET /awards/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/listawards.md): This method will scan all awards and and return them to the caller. - [POST /awards/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/createaward.md): This method will auto-generate an ID and create a new award. If an ID is specified for the award, an error will be thrown. - [POST /awards/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [POST /awards/{tenantId}/clone](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/cloneaward.md): Creates a copy of an award, along with other associated records - [GET /awards/{tenantId}/portal/browseOpen](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/browseopenawardsforportal.md): Returns a list of open awards available/visible in the portal - [POST /awards/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/searchforawards.md): Searches for awards using predefined parameters - [GET /awards/{tenantId}/type/{type_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/listawardsbytypeid.md): Returns a list of records with the specified type_id - [DELETE /awards/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/deleteaward.md): This method will delete a award with the specified ID. - [GET /awards/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/getaward.md): This method will look up a award by the specified ID and return it back. - [PATCH /awards/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/patchaward.md): This method will patch an existing award with the specified ID, using the HTTP PATCH specification. - [PUT /awards/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/awards/updateaward.md): This method will update an existing award with the specified ID. ## Categories - [POST /categories/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/categories/createcategory.md): This method will auto-generate an ID and create a new category. If an ID is specified for the category, an error will be thrown. - [GET /categories/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/categories/listcategoriesbyawardid.md): Returns a list of records with the specified award_id - [DELETE /categories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/categories/deletecategory.md): This method will delete a category with the specified ID. - [GET /categories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/categories/getcategory.md): This method will look up a category by the specified ID and return it back. - [PATCH /categories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/categories/patchcategory.md): This method will patch an existing category with the specified ID, using the HTTP PATCH specification. - [PUT /categories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/categories/updatecategory.md): This method will update an existing category with the specified ID. ## Coupons - [POST /coupons/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/createcoupon.md): This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown. - [GET /coupons/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/listcouponsbyawardid.md): Returns a list of records with the specified award_id - [POST /coupons/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /coupons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/deletecoupon.md): This method will delete a coupon with the specified ID. - [GET /coupons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/getcoupon.md): This method will look up a coupon by the specified ID and return it back. - [PATCH /coupons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/patchcoupon.md): This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification. - [PUT /coupons/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/coupons/updatecoupon.md): This method will update an existing coupon with the specified ID. ## Nomination Processes - [GET /nominationProcesses/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/listnominationprocesses.md): This method will scan all nomination processes and and return them to the caller. - [POST /nominationProcesses/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/createnominationprocess.md): This method will auto-generate an ID and create a new nomination process. If an ID is specified for the nomination process, an error will be thrown. - [GET /nominationProcesses/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/listprocessesbyawardid.md): Returns a list of records with the specified award_id - [POST /nominationProcesses/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /nominationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{customer_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/geteligibleprocesses.md) - [DELETE /nominationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/deletenominationprocess.md): This method will delete a nomination process with the specified ID. - [GET /nominationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/getnominationprocess.md): This method will look up a nomination process by the specified ID and return it back. - [PATCH /nominationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/patchnominationprocess.md): This method will patch an existing nomination process with the specified ID, using the HTTP PATCH specification. - [PUT /nominationProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nomination-processes/updatenominationprocess.md): This method will update an existing nomination process with the specified ID. ## Nominations - [POST /nominations/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/createnomination.md): This method will auto-generate an ID and create a new nomination. If an ID is specified for the nomination, an error will be thrown. - [GET /nominations/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/listnominationsbyawardid.md): Returns a list of records with the specified award_id - [POST /nominations/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /nominations/{tenantId}/contact/{contact_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/listnominationsbycontactid.md): Returns a list of records with the specified contact_id - [GET /nominations/{tenantId}/nominee/{nominee_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/listnominationsbynomineeid.md): Returns a list of records with the specified nominee_id - [GET /nominations/{tenantId}/organization/{organization_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/listnominationsbyorganizationid.md): Returns a list of records with the specified organization_id - [POST /nominations/{tenantId}/previewEmail](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/previewemail.md): Sends out a preview of the CRC notification email - [POST /nominations/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/searchfornominations.md): Searches for nominations using predefined parameters - [POST /nominations/{tenantId}/submit](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/submitnominations.md) - [DELETE /nominations/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/deletenomination.md): This method will delete a nomination with the specified ID. - [GET /nominations/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/getnomination.md): This method will look up a nomination by the specified ID and return it back. - [PATCH /nominations/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/patchnomination.md): This method will patch an existing nomination with the specified ID, using the HTTP PATCH specification. - [PUT /nominations/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominations/updatenomination.md): This method will update an existing nomination with the specified ID. ## Nominees - [POST /nominees/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/createnominee.md): This method will auto-generate an ID and create a new nominee. If an ID is specified for the nominee, an error will be thrown. - [GET /nominees/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/listnomineesbyawardid.md): Returns a list of records with the specified award_id - [POST /nominees/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /nominees/{tenantId}/customer/{ownerType}/{contactOrOrganizationId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/listnomineesbycontactid.md): Returns a list of records with the specified contact_id - [POST /nominees/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/searchfornominees.md): Searches for nominees using predefined parameters - [DELETE /nominees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/deletenominee.md): This method will delete a nominee with the specified ID. - [GET /nominees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/getnominee.md): This method will look up a nominee by the specified ID and return it back. - [PATCH /nominees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/patchnominee.md): This method will patch an existing nominee with the specified ID, using the HTTP PATCH specification. - [PUT /nominees/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/nominees/updatenominee.md): This method will update an existing nominee with the specified ID. ## Query Definitions - [GET /queryDefinitions/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/query-definitions/getquerydefinitions.md): Returns a list of records ## Recipient Categories - [POST /recipientCategories/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/createrecipientcategory.md): This method will auto-generate an ID and create a new recipient category. If an ID is specified for the recipient category, an error will be thrown. - [GET /recipientCategories/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/listcategoriesbyawardid.md): Returns a list of records with the specified award_id - [POST /recipientCategories/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /recipientCategories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/deleterecipientcategory.md): This method will delete a recipient category with the specified ID. - [GET /recipientCategories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/getrecipientcategory.md): This method will look up a recipient category by the specified ID and return it back. - [PATCH /recipientCategories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/patchrecipientcategory.md): This method will patch an existing recipient category with the specified ID, using the HTTP PATCH specification. - [PUT /recipientCategories/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipient-categories/updaterecipientcategory.md): This method will update an existing recipient category with the specified ID. ## Recipients - [POST /recipients/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/createrecipient.md): This method will auto-generate an ID and create a new recipient. If an ID is specified for the recipient, an error will be thrown. - [GET /recipients/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/listrecipientsbyawardid.md): Returns a list of records with the specified award_id - [POST /recipients/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /recipients/{tenantId}/ownerId/{ownerType}/{contactOrOrgId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/listrecipientsbyownertypecontactororgid.md): Returns a list of records with the specified owner_type - [POST /recipients/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/searchforrecipients.md): Searches for recipients using predefined parameters - [DELETE /recipients/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/deleterecipient.md): This method will delete a recipient with the specified ID. - [GET /recipients/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/getrecipient.md): This method will look up a recipient by the specified ID and return it back. - [PATCH /recipients/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/patchrecipient.md): This method will patch an existing recipient with the specified ID, using the HTTP PATCH specification. - [PUT /recipients/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/recipients/updaterecipient.md): This method will update an existing recipient with the specified ID. ## Reference Processes - [POST /referenceProcesses/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/createreferenceprocess.md): This method will auto-generate an ID and create a new reference process. If an ID is specified for the reference process, an error will be thrown. - [GET /referenceProcesses/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/listprocessesbyawardid.md): Returns a list of records with the specified award_id - [POST /referenceProcesses/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /referenceProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/deletereferenceprocess.md): This method will delete a reference process with the specified ID. - [GET /referenceProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/getreferenceprocess.md): This method will look up a reference process by the specified ID and return it back. - [PATCH /referenceProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/patchreferenceprocess.md): This method will patch an existing reference process with the specified ID, using the HTTP PATCH specification. - [PUT /referenceProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-processes/updatereferenceprocess.md): This method will update an existing reference process with the specified ID. ## Reference Types - [GET /referenceTypes/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/listreferencetypes.md): This method will scan all reference types and and return them to the caller. - [POST /referenceTypes/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/createreferencetype.md): This method will auto-generate an ID and create a new reference type. If an ID is specified for the reference type, an error will be thrown. - [POST /referenceTypes/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /referenceTypes/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/deletereferencetype.md): This method will delete a reference type with the specified ID. - [GET /referenceTypes/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/getreferencetype.md): This method will look up a reference type by the specified ID and return it back. - [PATCH /referenceTypes/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/patchreferencetype.md): This method will patch an existing reference type with the specified ID, using the HTTP PATCH specification. - [PUT /referenceTypes/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reference-types/updatereferencetype.md): This method will update an existing reference type with the specified ID. ## References - [POST /references/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/createreference.md): This method will auto-generate an ID and create a new reference. If an ID is specified for the reference, an error will be thrown. - [GET /references/{tenantId}/application/{application_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/listreferencesbyapplicationid.md): Returns a list of records with the specified reference_id - [POST /references/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /references/{tenantId}/contact/{contact_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/listreferencesbycontactid.md): Returns a list of records with the specified contact_id - [POST /references/{tenantId}/previewEmail](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/previewemail.md): Sends out a preview of the CRC notification email - [POST /references/{tenantId}/process/{application_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/processreferences.md): Sends out a preview of the CRC notification email - [POST /references/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/searchforreferences.md): Searches for references using predefined parameters - [POST /references/{tenantId}/submit](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/submitreference.md) - [DELETE /references/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/deletereference.md): This method will delete a reference with the specified ID. - [GET /references/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/getreference.md): This method will look up a reference by the specified ID and return it back. - [PATCH /references/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/patchreference.md): This method will patch an existing reference with the specified ID, using the HTTP PATCH specification. - [PUT /references/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/references/updatereference.md): This method will update an existing reference with the specified ID. ## Review Processes - [POST /reviewProcesses/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/createreviewprocess.md): This method will auto-generate an ID and create a new review process. If an ID is specified for the review process, an error will be thrown. - [GET /reviewProcesses/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/listprocessesbyawardid.md): Returns a list of records with the specified award_id - [POST /reviewProcesses/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /reviewProcesses/{tenantId}/eligible/{contactId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/geteligibleprocesses.md) - [DELETE /reviewProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/deletereviewprocess.md): This method will delete a review process with the specified ID. - [GET /reviewProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/getreviewprocess.md): This method will look up a review process by the specified ID and return it back. - [PATCH /reviewProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/patchreviewprocess.md): This method will patch an existing review process with the specified ID, using the HTTP PATCH specification. - [PUT /reviewProcesses/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-processes/updatereviewprocess.md): This method will update an existing review process with the specified ID. ## Review Rounds - [POST /reviewRounds/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/createreviewround.md): This method will auto-generate an ID and create a new review round. If an ID is specified for the review round, an error will be thrown. - [GET /reviewRounds/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/listroundsbyawardid.md): Returns a list of records with the specified award_id - [POST /reviewRounds/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /reviewRounds/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/deletereviewround.md): This method will delete a review round with the specified ID. - [GET /reviewRounds/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/getreviewround.md): This method will look up a review round by the specified ID and return it back. - [PATCH /reviewRounds/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/patchreviewround.md): This method will patch an existing review round with the specified ID, using the HTTP PATCH specification. - [PUT /reviewRounds/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/review-rounds/updatereviewround.md): This method will update an existing review round with the specified ID. ## Reviews - [POST /reviews/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/createreview.md): This method will auto-generate an ID and create a new review. If an ID is specified for the review, an error will be thrown. - [GET /reviews/{tenantId}/award/{award_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/listreviewsbyawardid.md): Returns a list of records with the specified award_id - [POST /reviews/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /reviews/{tenantId}/contact/{contact_id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/listreviewsbycontactid.md): Returns a list of records with the specified contact_id - [GET /reviews/{tenantId}/reviewRound/{review_round_id}/{status}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/listreviewsbyreviewroundidstatus.md): Returns a list of records with the specified review_round_id - [POST /reviews/{tenantId}/search](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/searchforreviews.md): Searches for reviews using predefined parameters - [POST /reviews/{tenantId}/submit](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/submitreview.md) - [DELETE /reviews/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/deletereview.md): This method will delete a review with the specified ID. - [GET /reviews/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/getreview.md): This method will look up a review by the specified ID and return it back. - [PATCH /reviews/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/patchreview.md): This method will patch an existing review with the specified ID, using the HTTP PATCH specification. - [PUT /reviews/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/reviews/updatereview.md): This method will update an existing review with the specified ID. ## Settings - [DELETE /settings/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/settings/deletesetting.md): This method will delete a setting with the specified ID. - [GET /settings/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/settings/getsetting.md): This method will look up a setting by the specified ID and return it back. - [PATCH /settings/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/settings/patchsetting.md): This method will patch an existing setting with the specified ID, using the HTTP PATCH specification. - [POST /settings/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/settings/createsetting.md): This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown. - [PUT /settings/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/settings/updatesetting.md): This method will update an existing setting with the specified ID. ## Statistics - [POST /statistics/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/statistics/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [GET /statistics/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/statistics/getstatistic.md): This method will look up a statistic by the specified ID and return it back. ## Types - [GET /types/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/listtypes.md): This method will scan all types and and return them to the caller. - [POST /types/{tenantId}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/createtype.md): This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown. - [POST /types/{tenantId}/batch](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/executebatchoperations.md): TAllows you to perform up to 100 parallel patch/delete operations - [DELETE /types/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/deletetype.md): This method will delete a type with the specified ID. - [GET /types/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/gettype.md): This method will look up a type by the specified ID and return it back. - [PATCH /types/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/patchtype.md): This method will patch an existing type with the specified ID, using the HTTP PATCH specification. - [PUT /types/{tenantId}/{id}](https://docs.api.rhythmsoftware.com/apis/awards/awards-v1/types/updatetype.md): This method will update an existing type with the specified ID.