User Story Rating

User Story Ratings provide many benefits both in the User Interface and through the Agile Ready API

Agile Ready Ratings API 

API Endpoints

Agile Ready’s API endpoints and schemas are listed below. There are three endpoints in the current 2023 Release. They are:

API access

To gain access to the Agile Ready API, create a trial or paid account at https://beagileready.com. Once you’ve completed the signup process and acknowledged our terms, you be able to generate the required API Keys to access the endpoints. The number of API calls you can make will vary based on the type of account created.

Administrator / Root Account

Agile Ready accounts, upon successful activation, create an administrator account also know as the root account. This account, based on subscription level, can ADD additional users to the account. The API Key administration function within Agile Ready is only available to the administrator or root account.

API protocols and headers

The Agile Ready API uses POST requests to communicate and HTTP response codes to indicate status and errors. All responses come in standard JSON. The Agile Ready API is served over HTTPS TLS v1.2+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.2 are not supported. All requests must include a Content-Type of application/json and the body must be valid JSON. 

The Agile Ready API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

All Agile Ready API endpoints require an API KEY. These may be sent either in the request body or in the headers.

API host

Agile Ready has one environment: Production at https://beagileready.com. All activity in the Production environment is either at no cost in the trial edition or included in the cost of a paid account. The number of API calls you can make will vary based on the type of account created.

/api/ar-rate-user-story/

Rate a User Story

Use /api/ar-rate-user-story/ to rate a User Story to get a numerical score of the quality of form compliance. User Story form compliance is described further in section, FORM COMPLIANCE.

In order to obtain a valid score for the User Story, Agile Ready must have a valid API key for the account. If the transaction does not have a valid API key, an error will be returned corresponding to the underlying cause.

/api/ar-rate-job-story/

Use /api/ar-rate-job-story/ to rate a Job Story to get a numerical score of the quality of form compliance. Job Story form compliance is described further in section, FORM COMPLIANCE.

In order to obtain a valid score for the Job Story, Agile Ready must have a valid API key for the account. If the transaction does not have a valid API key, an error will be returned corresponding to the underlying cause.

 /api/ar-rate-test-story/

Use /api/ar-rate-test-story/ to rate a Test Story to get a numerical score of the quality of form compliance. Test Story form compliance is described further in section, FORM COMPLIANCE.

In order to obtain a valid score for the Test Story, Agile Ready must have a valid API key for the account. If the transaction does not have a valid API key, an error will be returned corresponding to the underlying cause.

 FORM COMPLIANCE

A User Story is an agile method innovation that provides a product managers, product owners and programmers an informal, from a user’s point of view, description of software behavior or features in a software system.

User Story Format

A defacto format has emerged for the user story form or syntax. The form or syntax provides readers a quick overview of the who, what and why or the intent of the user story. This format has three parts including fixed and variable components.

Table 1: User Story Format

When the user story string is rated, it is compared to the above defacto format where the fixed and variable components are parsed, detected and analyzed. The more it conforms to the correct format the higher a Readiness Quality Score (RQS) it receives. The RQS range of numerical values and corresponding color assignments are described in the table below.

Table 2: RQS Score Rating Table

Agile Ready has added TWO other story format checks with the other two endpoints including a Job Story and a Test Story.

Job Story Format

A Job Story is an alternative method developed by the Mountain Goat Software innovator, Mike Cohn. It describes a different syntax set that the User Story for situations that may be a better fit than the user story format.

Table 3: Job Story format

When the job story string is rated, it is compared to the above defacto format where the fixed and variable components are parsed, detected and analyzed. The more it conforms to the correct format the higher a Readiness Quality Score (RQS) it receives. The RQS range of numerical values and corresponding color assignments are described Table 2: RQS Score Rating Table.

Test Story Format

A Test Story is Behavior Driven Development (BDD) inspired format that has been used to write acceptance criteria for User Stories but is also suitable as a format for describing functionality. When used in acceptance criteria and conforming to the format

Table 4: Test Story Format

When the job story string is rated, it is compared to the above defacto format where the fixed and variable components are parsed, detected and analyzed. The more it conforms to the correct format the higher a Readiness Quality Score (RQS) it receives. The RQS range of numerical values and corresponding color assignments are described Table 1: RQS Score Rating Table.

 Postman Example for reference

The POSTMAN tool provides an easy way to access and validate your use of the API.