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.

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

Staging #410 - Update details in Common Field Types section #420

Merged
merged 4 commits into from
Oct 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Release notes for version v1.32.0 of the [CDR Standards](../../index.html).

This release addresses the following minor defects raised on [Standards Staging](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues):

- [Standards Staging #410 - Clarify RateString description and examples](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/410)
- [Standards Staging #413 - Merge Change Log and Archives sections](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/413)

This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
Expand Down Expand Up @@ -44,6 +45,7 @@ This release addresses the following Decision Proposals published on [Standards]
## High Level Standards
|Change|Description|Link|
|------|-----------|----|
| Common Field Types examples | [**Standards Staging #410**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/410): Clarified formatting of RateString type | [Common Field Types](../../#common-field-types)


## API Endpoints
Expand Down
6 changes: 4 additions & 2 deletions slate/source/includes/standards/_types.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Common Field Types


```diff
Clarified formatting of RateString type
```

The following table outlines the common data types for fields used in the standard.

Expand All @@ -20,7 +22,7 @@ DateTimeString | Combined Date and Time string as per **[[RFC3339]](#nref-RFC333
DateString | Date string as per **[[RFC3339]](#nref-RFC3339)** (labelled full-date in the RFC) | “2007-05-01”<br/>“2012-12-25”
TimeString | Time string as per **[[RFC3339]](#nref-RFC3339)** (labelled full-time in the RFC). As specified in **[[RFC3339]](#nref-RFC3339)** times MUST be offset relative to UTC | “15:43:00.12345Z”<br/>“15:43:00-12:00”
CurrencyString | Standard 3 character currency codes as per ISO-4217 | “AUD”<br/>“USD”<br/>“GBP”
RateString | A string representing a percentage (e.g. an interest rate). A rate of 100% would be represented by the value 1.0 and a rate of -100% by -1.0<br/>- At least 1 and up to a total of 16 significant digits before decimal point<br/>- Up to 16 digits following the decimal point<br/>- No formatting, eg thousand separating commas | “0.05”`(=5%)`<br/>“-0.05”`(=-5%)`<br/>“12.3456789”`(=1234.56789%)`<br/>“-99.123456789123”`(=9912.3456789123%)`
RateString | A string representing a percentage (e.g., an interest rate). For example, a rate of 100% would be represented by the value `"1"` and a rate of -100% by `"-1"`<br/>- At least 1 and up to a total of 16 significant digits before a decimal point<br/>- Up to 16 digits following a decimal point if required<br/>- No formatting, e.g., thousand-separating commas. | `"0"` or `"0.0"` (0%)<br/>`"1"` or `"1.0"` (100%)<br/>`"-1.234567"` (-123.4567%)<br/>`"-0.056"` (-5.6%)<br/>`"0.03456789"` (3.456789%)<br/>`"0.2"` (20%)<br/>`"23.456"` (2345.6%)
AmountString | A string representing an amount of currency.<br/>- A positive, zero or negative number<br/>- Negative numbers identified with a ‘-‘<br/>- Currency symbols MUST NOT be supplied<br/>- At least 1 and up to a total of 16 significant digits before decimal point<br/>- Minimum 2 digits following a decimal point (more digits allowable but only if required)<br/>- No additional formatting, eg thousand separating commas | “0.01”<br/>“10.00”<br/>“1234567.89”<br/>“-1001.23”<br/>“1.999”
MaskedPANString | Masked credit card number. Lower case ‘x’ MUST be used to mask numbers and only the last four digits MUST be exposed to facilitate identification. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234"
MaskedAccountString | Masked bank account number genericised for a variety of account types. MUST be represented as the full account number would normally be represented for display (including formatting) but with all digits except the last four replaced with a lowercase x. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234"<br/>"xxx-xxx xxxxx1234"
Expand Down