Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make response expiry date mandatory for both launch formats #83

Merged
merged 2 commits into from
May 18, 2023
Merged

Make response expiry date mandatory for both launch formats #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
767984e
Update both launch formats
petechd May 11, 2023
3e20d81
Make response expires at mandatory in both launch json files
petechd May 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rm_to_eq_runner_payload_v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ do not appear in individual survey metadata definitions.
| **response_id** | A unique identifier for the questionnaire response |
| **ru_ref** | The reporting unit reference - with check letter appended. |
| **user_id** | The identifier assigned by the respondent management system |
| **response_expires_at** | An ISO 8601 formatted date time, after which the unsubmitted partial response can be deleted from the database |

#### Schema Selection Fields

Expand Down Expand Up @@ -63,7 +64,6 @@ EQ Runner can optionally accept the following properties.
| **language_code** | Language code identifier, used to change language displayed. Format as per ISO-639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) e.g. "en" for English; "cy" for Welsh. This parameter is currently optional; the default is "en" |
| **period_str** | A display name for the `period_id` referenced above |
| **region_code** | The Region Code of the questionnaire response. Format as per ISO 3166-2 (https://en.wikipedia.org/wiki/ISO_3166-2:GB) i.e. `GB-ENG` / `GB-WLS` / `GB-NIR`. This is used in tactical legacy solutions for Individual Response, Email and Feedback features. |
| **response_expires_at** | An ISO 8601 formatted date time, after which the unsubmitted partial response can be deleted from the database |
| **survey** | The survey being launched (deprecated) |
| **survey_id** | The survey identifier as used across the ONS (e.g. `009`) (deprecated) |
| **return_by** | The return by date (deprecated) |
Expand Down
24 changes: 12 additions & 12 deletions docs/rm_to_eq_runner_payload_v2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,18 @@ This document defines the JWT payload structure for v2.

The following metadata properties are always required for the EQ Runner, they do not appear in individual survey metadata definitions.

| **Property** | **Definition** |
| --------------------------- | ------------------------------------------------------------------------------------------ |
| **iat** | JWT Issued At claim, see https://tools.ietf.org/html/rfc7519#section-4.1.6 |
| **exp** | JWT Expiration Time claim, see https://tools.ietf.org/html/rfc7519#section-4.1.4 |
| **jti** | See [JWT Profile][jwt_profile] |
| **account_service_url** | The base URL of the calling service used to launch the survey |
| **case_id** | The case UUID, used to identify a single instance of a survey collection for a respondent |
| **collection_exercise_sid** | A reference UUID used to represent the collection exercise inside the ONS |
| **response_id** | A unique identifier for the questionnaire response |
| **tx_id** | See: [JWT Profile][jwt_profile] |
| **version** | The version number for this JWT payload specification. For this format, this must be `v2`. |
| **Property** | **Definition** |
|-----------------------------|---------------------------------------------------------------------------------------------------------------|
| **iat** | JWT Issued At claim, see https://tools.ietf.org/html/rfc7519#section-4.1.6 |
| **exp** | JWT Expiration Time claim, see https://tools.ietf.org/html/rfc7519#section-4.1.4 |
| **jti** | See [JWT Profile][jwt_profile] |
| **account_service_url** | The base URL of the calling service used to launch the survey |
| **case_id** | The case UUID, used to identify a single instance of a survey collection for a respondent |
| **collection_exercise_sid** | A reference UUID used to represent the collection exercise inside the ONS |
| **response_id** | A unique identifier for the questionnaire response |
| **tx_id** | See: [JWT Profile][jwt_profile] |
| **version** | The version number for this JWT payload specification. For this format, this must be `v2`. |
| **response_expires_at** | An ISO_8601 formatted date-time after which the unsubmitted partial response can be deleted from the database |

#### Schema Selection Fields

Expand All @@ -45,7 +46,6 @@ EQ Runner can optionally accept the following keys.
| **channel** | The channel (client) from which the questionnaire was launched |
| **language_code** | Language code identifier, used to change language displayed. Format as per ISO-639-1 (https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) e.g. "en" for English; "cy" for Welsh. This parameter is currently optional; the default is "en" |
| **region_code** | The Region Code of the questionnaire response. Format as per ISO 3166-2 (https://en.wikipedia.org/wiki/ISO_3166-2:GB) i.e. `GB-ENG` / `GB-WLS` / `GB-NIR`. This is used in tactical legacy solutions for Individual Response, Email and Feedback features. |
| **response_expires_at** | An ISO_8601 formatted date-time after which the unsubmitted partial response can be deleted from the database |
| **survey_metadata** | See: [Survey Metadata Fields][survey_metadata_fields] |

### Survey Metadata Fields
Expand Down
3 changes: 2 additions & 1 deletion schemas/launch_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@
"response_id",
"period_id",
"ru_ref",
"user_id"
"user_id",
"response_expires_at"
],
"additionalProperties": false,
"anyOf": [
Expand Down
3 changes: 2 additions & 1 deletion schemas/launch_v2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@
"account_service_url",
"case_id",
"collection_exercise_sid",
"response_id"
"response_id",
"response_expires_at"
],
"additionalProperties": false,
"oneOf": [
Expand Down