Nomination Stages for a given job represent an ordered sequence of states that a candidate nominations can progress through.
Relationships:
The Nomination Stages relationships can be either of the following:
Job to Nomination Stages can be 1-Many: Set job_id to the job UUID for this use case.
Job to Nomination Stages can be independent: Don't set job_id to create stages that are global to your system. This would allow a single stage to be used by multiple nominations across multiple job.
Create a Nomination Stage
POSThttps://endorsed.ai/api/v1/nomination_stages
Creates a new Nomination Stage and returns the Nomination Stage's UUID id.
Headers
Name
Type
Description
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json. If not set, defaults to application/json
Request Body
Name
Type
Description
job_id
string
The Job UUID from the /jobs entity resource. Can be optional in the case that a stage should be used / referenced for any nomination regardless of which job that nomination is associated with.
name*
string
The name of the Nomination Stage
stage_order_index*
integer
The order index of this stage amongst the stages under this job, which must be unique per job or unique among the global nomination stages. All of the stage order indices under a job or amongst the global nomination stages are considered sequenced in ascending numeric order.
remote_id*
string
The
id
of the Nomination Stage from the originating system
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"FORBIDDEN","issues": [ {"message":"Access to this resource is not authorized." } ] }}
{"is_error":true,"error": {"code":"NOT_FOUND","issues": [ {"message":"This resource entity does not exist." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}
Updates an existing Nomination Stage by it's UUID id.
Headers
Name
Type
Description
Authorization*
string
Authorization header containing the Bearer Access Token from the /auth/tokens endpoint. Example: Bearer <ACCESS_TOKEN>
Content-Type
string
Must be application/json. If not set, defaults to application/json
Request Body
Name
Type
Description
name*
string
The name of the Nomination Stage
stage_order_index*
integer
The order index of this stage amongst the stages under this job, which must be unique per job or unique among the global nomination stages. All of the stage order indices under a job or amongst the global nomination stages are considered sequenced in ascending numeric order.
{"is_error":true,"error": {"code":"UNAUTHENTICATED","issues": [ {"message":"Resource requires authentication. Please provide a valid access token." } ] }}
{"is_error":true,"error": {"code":"FORBIDDEN","issues": [ {"message":"Access to this resource is not authorized." } ] }}
{"is_error":true,"error": {"code":"NOT_FOUND","issues": [ {"message":"This resource entity does not exist." } ] }}
{"is_error":true,"error": {"code":"INTERNAL_SERVER_ERROR","issues": [ { "message": "An unexpected error occurred on our end. Please try again later, and if the problem persists, contact our support team"
} ] }}