{ "swagger": "2.0", "info": { "version": "v2.2", "title": "Open Data API", "description": "Latest Swagger specification for OpenData FCA Service Metrics" }, "host": "developer.openbanking.org.uk", "basePath": "/open-banking/v2.2", "schemes": [ "https" ], "produces": [ "application/prs.openbanking.opendata.v2.2+json" ], "tags": [ { "name": "FCSSRVM", "description": "Endpoint for getting FCA Service Metrics data" } ], "paths": { "/fca_service_metrics": { "get": { "tags": [ "FCSSRVM" ], "description": "Gets a list of all `FCA Service Metrics` objects.", "parameters": [ { "name": "If-Modified-Since", "type": "string", "description": "Used for conditional request, to retrieve data only if modified since a given date", "in": "header", "required": false }, { "name": "If-None-Match", "type": "string", "description": "Used for conditional request, to retrieve data only if the given Etag value does not match", "in": "header", "required": false } ], "responses": { "200": { "description": "Successful response with a list of `FCA Service Metrics` data", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header", "default": "max-age=31536000" }, "Etag": { "type": "string", "description": "A unique ID identifying whether this resource has changed" }, "Cache-Control": { "type": "string", "description": "Describes how long this response can be cached", "default": "max-age=28800" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" } }, "schema": { "type": "object", "properties": { "meta": { "title": "Meta data", "type": "object", "properties": { "LastUpdated": { "type": "string", "format": "date-time" }, "TotalResults": { "type": "integer" }, "Agreement": { "type": "string", "enum": [ "Use of the APIs and any related data will be subject to the terms of the Open Licence and subject to terms and conditions" ] }, "License": { "description": "Open Banking License", "type": "string", "format": "uri", "enum": [ "https://www.openbanking.org.uk/open-licence" ] }, "TermsOfUse": { "description": "Open Banking Terms of Use", "type": "string", "format": "uri", "enum": [ "https://www.openbanking.org.uk/terms" ] } }, "required": [ "LastUpdated", "TotalResults", "Agreement", "License", "TermsOfUse" ], "additionalProperties": false }, "data": { "type": "array", "items": { "properties": { "Brand": { "description": "Brand owned by an organisation", "type": "array", "title": "Brand", "items": { "description": "Brand owned by an organisation", "type": "object", "properties": { "BrandName": { "description": "Brand Name that an organisation uses to market its products or services to a consumer", "title": "BrandName", "type": "string", "minLength": 1, "maxLength": 140 }, "EffectiveDate": { "title": "EffectiveDate", "description": "ISO Date as per https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14", "type": "string", "format": "date" }, "Notes": { "description": "Specify any note that helps Banks to describe the Service Metrics Data related to a particular Brand. One example to describe, why the Service Metrics data is not available.", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "ServicesContactAndExecution": { "type": "array", "title": "ServicesContactAndExecution", "items": { "type": "object", "properties": { "ServicesAvailabilityDetails": { "description": "How and when you can contact us to ask about the following things:", "type": "array", "title": "ServicesAvailabilityDetails", "items": { "description": "How and when you can contact us to ask about the following things:", "type": "object", "properties": { "ServicesContactType": { "title": "ServicesContactType", "type": "string", "enum": [ "AccessViaPowerOfAttorney", "CheckBalanceTransaction", "CancellingCheck", "DnialLackOfFunds", "ReportFraudlentIncident", "ProblemUsingMobileInternetBanking", "SendingMoneyWithinUK", "SendingMoneyOutsideUK", "PayingInCheck", "Other", "HelpOpeningAccount", "CollectPaymentViaCard", "CashWithdrawalForexOutsideUK" ] }, "24HourAvailable": { "description": "Indicates whether this contact type is available 24 hours.", "title": "24HourAvailable", "type": "string", "enum": [ "InSomeCases", "NotApplicable", "No", "Yes" ] }, "OtherServicesContactType": { "description": "Other coe set which is not available in the standard ServicesAvailabilityCode set", "type": "array", "title": "OtherServicesContactType", "items": { "description": "Other coe set which is not available in the standard ServicesAvailabilityCode set", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false }, "ContactDetails": { "description": "Communication device number or electronic address used for communication.", "type": "object", "title": "ContactDetails", "properties": { "ContactType": { "description": "Contact type such Phone, Fax and email", "title": "ContactType", "type": "string", "enum": [ "AlternateEmail", "AlternateFax", "AlternatePhone", "Email", "Fax", "Other", "Phone", "WebChat" ] }, "ContactContent": { "description": "Collection of information that identifies a phone/Fax number/ email/WebChat or other communication channel, as defined by telecom services.", "title": "ContactContent", "type": "string", "minLength": 1, "maxLength": 256 }, "ContactDescription": { "description": "Description of contact such as main phone number, alternate phone number, Fax number, alternate fax number, email, alternate email and WebChat App name.", "title": "ContactDescription", "type": "string", "minLength": 1, "maxLength": 70 }, "OtherContactType": { "description": "Other contact type which is not in the standard code list", "type": "object", "title": "OtherContactType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "additionalProperties": false, "required": [ "ContactType", "ContactContent" ] }, "ContactAvailabilityMethod": { "type": "array", "title": "ContactAvailabilityMethod", "items": { "type": "object", "properties": { "ContactMethodType": { "title": "ContactMethodType", "type": "string", "enum": [ "TelephoneBanking", "InternetBanking", "MobileBanking", "Other", "Telephone" ] }, "24HourAvailable": { "description": "Indicates whether this contact type is available 24 hours.", "title": "24HourAvailable", "type": "string", "enum": [ "InSomeCases", "NotApplicable", "No", "Yes" ] }, "ServiceLevelDescription": { "description": "Summary description of the ATM.", "title": "ServiceLevelDescription", "type": "string", "minLength": 1, "maxLength": 2000 }, "Note": { "description": "Any info which supports the Contact Availability Method.", "title": "Note", "type": "string", "minLength": 1, "maxLength": 2000 }, "OtherContactMethodType": { "description": "Other coe set which is not available in the standard ContactMethodTypeCode set.", "type": "array", "title": "OtherContactMethodType", "items": { "description": "Other coe set which is not available in the standard ContactMethodTypeCode set.", "type": "object", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "required": [ "Name", "Description" ] }, "additionalProperties": false }, "Day": { "description": "Working day information", "type": "array", "title": "Day", "items": { "description": "Working day information", "type": "object", "properties": { "Name": { "description": "Specifies the day of the week", "title": "Name", "type": "string", "enum": [ "Friday", "Monday", "Saturday", "Sunday", "Thursday", "Tuesday", "Wednesday" ] }, "Notes": { "description": "Specify any note that is related the particular opening day e.g. Closed half day on Monday", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "AvailableHours": { "description": "Opening & Closing Times of a branch of an organisation", "type": "array", "title": "AvailableHours", "items": { "description": "Opening & Closing Times of a branch of an organisation", "type": "object", "properties": { "OpeningTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "OpeningTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" }, "ClosingTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "ClosingTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" } }, "required": [ "OpeningTime", "ClosingTime" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "Name", "AvailableHours" ] }, "additionalProperties": false }, "NonAvailability": { "description": "Non-standard hours of availability for a branch of an organisation", "type": "array", "title": "NonAvailability", "items": { "description": "Non-standard hours of availability for a branch of an organisation", "type": "object", "properties": { "Name": { "description": "Name provided for non-standard opening periods e.g. Christmas", "title": "Name", "type": "string", "minLength": 1, "maxLength": 140 }, "StartDate": { "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "title": "StartDate", "type": "string", "format": "date" }, "EndDate": { "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "title": "EndDate", "type": "string", "format": "date" }, "Notes": { "description": "Notes related to the Non-standard hours e.g. During shrimp season, the branch has extended opening hours", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "Day": { "description": "Working day information", "type": "array", "title": "Day", "items": { "description": "Working day information", "type": "object", "properties": { "Name": { "description": "Specifies the day of the week", "title": "Name", "type": "string", "enum": [ "Friday", "Monday", "Saturday", "Sunday", "Thursday", "Tuesday", "Wednesday" ] }, "Notes": { "description": "Specify any note that is related the particular opening day e.g. Closed half day on Monday", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "AvailableHours": { "description": "Opening & Closing Times of a branch of an organisation", "type": "array", "title": "AvailableHours", "items": { "description": "Opening & Closing Times of a branch of an organisation", "type": "object", "properties": { "OpeningTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "OpeningTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" }, "ClosingTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "ClosingTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" } }, "required": [ "OpeningTime", "ClosingTime" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "Name", "AvailableHours" ] }, "additionalProperties": false, "minItems": 0, "maxItems": 7 } }, "required": [ "Name" ] }, "additionalProperties": false } }, "required": [ "ContactMethodType", "24HourAvailable" ] }, "additionalProperties": false }, "ExecutionAvailabilityMethod": { "type": "array", "title": "ExecutionAvailabilityMethod", "items": { "type": "object", "properties": { "ExecutionMethodType": { "title": "ExecutionMethodType", "type": "string", "enum": [ "TelephoneBanking", "InternetBanking", "MobileBanking", "Other", "Telephone" ] }, "Note": { "description": "Any info which supports Execution availability method for a service", "title": "Note", "type": "string", "minLength": 1, "maxLength": 2000 }, "OtherExecutionMethodType": { "description": "Other coe set which is not available in the standard ExecutionMethodTypeCode set.", "type": "object", "title": "OtherExecutionMethodType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "Day": { "description": "Working day information", "type": "array", "title": "Day", "items": { "description": "Working day information", "type": "object", "properties": { "Name": { "description": "Specifies the day of the week", "title": "Name", "type": "string", "enum": [ "Friday", "Monday", "Saturday", "Sunday", "Thursday", "Tuesday", "Wednesday" ] }, "Notes": { "description": "Specify any note that is related the particular opening day e.g. Closed half day on Monday", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "AvailableHours": { "description": "Opening & Closing Times of a branch of an organisation", "type": "array", "title": "AvailableHours", "items": { "description": "Opening & Closing Times of a branch of an organisation", "type": "object", "properties": { "OpeningTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "OpeningTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" }, "ClosingTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "ClosingTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" } }, "required": [ "OpeningTime", "ClosingTime" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "Name", "AvailableHours" ] }, "additionalProperties": false }, "NonAvailability": { "description": "Non-standard hours of availability for a branch of an organisation", "type": "array", "title": "NonAvailability", "items": { "description": "Non-standard hours of availability for a branch of an organisation", "type": "object", "properties": { "Name": { "description": "Name provided for non-standard opening periods e.g. Christmas", "title": "Name", "type": "string", "minLength": 1, "maxLength": 140 }, "StartDate": { "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "title": "StartDate", "type": "string", "format": "date" }, "EndDate": { "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "title": "EndDate", "type": "string", "format": "date" }, "Notes": { "description": "Notes related to the Non-standard hours e.g. During shrimp season, the branch has extended opening hours", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "Day": { "description": "Working day information", "type": "array", "title": "Day", "items": { "description": "Working day information", "type": "object", "properties": { "Name": { "description": "Specifies the day of the week", "title": "Name", "type": "string", "enum": [ "Friday", "Monday", "Saturday", "Sunday", "Thursday", "Tuesday", "Wednesday" ] }, "Notes": { "description": "Specify any note that is related the particular opening day e.g. Closed half day on Monday", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 }, "AvailableHours": { "description": "Opening & Closing Times of a branch of an organisation", "type": "array", "title": "AvailableHours", "items": { "description": "Opening & Closing Times of a branch of an organisation", "type": "object", "properties": { "OpeningTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "OpeningTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" }, "ClosingTime": { "description": "A particular point in the progression of time in a calendar day expressed in either UTC time format (hh:mm:ss.sssZ), local time with UTC offset format (hh:mm:ss.sss+/-hh:mm), or local time format (hh:mm:ss.sss). These representations are defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.\nNote on the time format:\n1) beginning / end of calendar day\n00:00:00 = the beginning of a calendar day\n24:00:00 = the end of a calendar day\n2) fractions of second in time format\nDecimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.", "title": "ClosingTime", "type": "string", "pattern": "^(2[0-3]|[01][0-9]):?([0-5][0-9])$" } }, "required": [ "OpeningTime", "ClosingTime" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "Name", "AvailableHours" ] }, "additionalProperties": false, "minItems": 0, "maxItems": 7 } }, "required": [ "Name" ] }, "additionalProperties": false } }, "required": [ "ExecutionMethodType" ] }, "additionalProperties": false } }, "required": [ "ServicesContactType", "24HourAvailable" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "ServicesAvailabilityDetails" ] }, "additionalProperties": false }, "ServiceContactTypeDetails": { "type": "object", "title": "ServiceContactTypeDetails", "properties": { "ContactAvailabilityMethod": { "type": "array", "title": "ContactAvailabilityMethod", "items": { "type": "object", "properties": { "ContactMethodType": { "title": "ContactMethodType", "type": "string", "enum": [ "TelephoneBanking", "InternetBanking", "MobileBanking", "Other", "Telephone" ] }, "OtherContactMethodType": { "description": "Other coe set which is not available in the standard ExecutionMethodType code set.", "type": "object", "title": "OtherContactMethodType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "ContactTypeDetails": { "description": "Communication device number or electronic address used for communication.", "type": "array", "title": "ContactTypeDetails", "items": { "description": "Communication device number or electronic address used for communication.", "type": "object", "properties": { "ContactType": { "description": "Contact type such Phone, Fax and email", "title": "ContactType", "type": "string", "enum": [ "AlternateEmail", "AlternateFax", "AlternatePhone", "Email", "Fax", "Other", "Phone", "WebChat" ] }, "ContactContent": { "description": "Collection of information that identifies a phone/Fax number/ email/WebChat or other communication channel, as defined by telecom services.", "title": "ContactContent", "type": "string", "minLength": 1, "maxLength": 256 }, "ContactDescription": { "description": "Description of contact such as main phone number, alternate phone number, Fax number, alternate fax number, email, alternate email and WebChat App name.", "title": "ContactDescription", "type": "string", "minLength": 1, "maxLength": 70 }, "OtherContactType": { "description": "Other contact type which is not in the standard code list", "type": "object", "title": "OtherContactType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "ContactType", "ContactContent" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "ContactMethodType", "ContactTypeDetails" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "ContactAvailabilityMethod" ] }, "OperationalIncidentMetrics": { "type": "object", "title": "OperationalIncidentMetrics", "properties": { "OperationalSecurityIncidentMetricsDetails": { "type": "array", "title": "OperationalSecurityIncidentMetricsDetails", "items": { "type": "object", "properties": { "IncidentMetricsType": { "title": "IncidentMetricsType", "type": "string", "enum": [ "IncidentsAffectingInternetBanking", "IncidentsAffectingMobBanking", "Other", "IncidentsAffectingTelBanking", "TotalNumberIncidentReported" ] }, "OtherIncidentMetricsType": { "description": "Other coe set which is not available in the standard code set.", "type": "object", "title": "OtherIncidentMetricsType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "IncidentDetails": { "type": "array", "title": "IncidentDetails", "items": { "type": "object", "properties": { "IncidentReportingType": { "title": "IncidentReportingType", "type": "string", "enum": [ "Other", "Quarterly", "Yearly" ] }, "FromDate": { "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "title": "FromDate", "type": "string", "format": "date" }, "ToDate": { "description": "A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in \"XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004\" which is aligned with ISO 8601.", "title": "ToDate", "type": "string", "format": "date" }, "IncidentCount": { "title": "IncidentCount", "description": "Integer", "type": "integer", "format": "int32" }, "OtherIncidentReportingType": { "description": "Other coe set which is not available in the standard code set.", "type": "object", "title": "OtherIncidentReportingType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "IncidentReportingType", "FromDate", "ToDate", "IncidentCount" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "IncidentMetricsType", "IncidentDetails" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "OperationalSecurityIncidentMetricsDetails" ] }, "ComplaintsData": { "type": "object", "title": "ComplaintsData", "properties": { "CompliantsDataDetails": { "type": "object", "title": "CompliantsDataDetails", "properties": { "CompliantsDataAvailable": { "title": "CompliantsDataAvailable", "description": "Boolean", "type": "boolean" }, "CompliantsInfoURL": { "description": "URL provided by the organisation which redirects to the product (on live products only) available on an external website. There might be more than one product at a given URL.", "title": "CompliantsInfoURL", "type": "string", "minLength": 1, "maxLength": 500 }, "Notes": { "description": "Notes related to the Non-standard hours e.g. During shrimp season, the branch has extended opening hours", "title": "Notes", "type": "string", "minLength": 1, "maxLength": 2000 } }, "additionalProperties": false, "required": [ "CompliantsDataAvailable" ] } }, "additionalProperties": false, "required": [ "CompliantsDataDetails" ] }, "AccountOpeningTimeLineDetails": { "type": "object", "title": "AccountOpeningTimeLineDetails", "properties": { "AccountOpeningURL": { "description": "URL provided by the organisation which redirects to the product (on live products only) available on an external website. There might be more than one product at a given URL.", "title": "AccountOpeningURL", "type": "string", "minLength": 1, "maxLength": 500 }, "AccountOpeningDocumentationURL": { "description": "URL provided by the organisation which redirects to the product (on live products only) available on an external website. There might be more than one product at a given URL.", "title": "AccountOpeningDocumentationURL", "type": "string", "minLength": 1, "maxLength": 500 }, "AccountOpeningTimelineParameters": { "type": "array", "title": "AccountOpeningTimelineParameters", "items": { "type": "object", "properties": { "OpeningAccountTimelineType": { "title": "OpeningAccountTimelineType", "type": "string", "enum": [ "OpenCurrentAccountsAvailability", "DebitCardAvailability", "CardReplacement", "InternetBankingAvailability", "OverdraftAvailability", "Other" ] }, "OtherTimelineType": { "description": "Other coe set which is not available in the standard Account opening timeline code set.", "type": "object", "title": "OtherTimelineType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] }, "AccountOpeningTimelineMetrics": { "type": "array", "title": "AccountOpeningTimelineMetrics", "items": { "type": "object", "properties": { "OpeningAccountTimelineMetricsType": { "title": "OpeningAccountTimelineMetricsType", "type": "string", "enum": [ "OnAnAverage", "Other", "SameDay", "WithingDays" ] }, "MetricsValue": { "title": "MetricsValue", "description": "Integer", "type": "integer", "format": "int32" }, "OtherTimelineMetricsType": { "description": "Other coe set which is not available in the standard TimelineMetricsType code set.", "type": "object", "title": "OtherTimelineMetricsType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "OpeningAccountTimelineMetricsType", "MetricsValue" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "OpeningAccountTimelineType", "AccountOpeningTimelineMetrics" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "AccountOpeningURL", "AccountOpeningDocumentationURL", "AccountOpeningTimelineParameters" ] }, "CardReplacementTimeLine": { "type": "object", "title": "CardReplacementTimeLine", "properties": { "CardReplacementTimeLineDetails": { "type": "array", "title": "CardReplacementTimeLineDetails", "items": { "type": "object", "properties": { "CardReplacementTimeline": { "title": "CardReplacementTimeline", "type": "array", "items": { "type": "string", "enum": [ "OpenCurrentAccountsAvailability", "DebitCardAvailability", "CardReplacement", "InternetBankingAvailability", "OverdraftAvailability", "Other" ] }, "minItems": 1 }, "CardReplacementMetrics": { "type": "array", "title": "CardReplacementMetrics", "items": { "type": "object", "properties": { "OpeningAccountTimelineMetricsType": { "title": "OpeningAccountTimelineMetricsType", "type": "string", "enum": [ "OnAnAverage", "Other", "SameDay", "WithingDays" ] }, "MetricsValue": { "title": "MetricsValue", "description": "Integer", "type": "integer", "format": "int32" }, "OtherTimelineMetricsType": { "description": "Other coe set which is not available in the standard TimelineMetrics code set.", "type": "object", "title": "OtherTimelineMetricsType", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "OpeningAccountTimelineMetricsType", "MetricsValue" ] }, "additionalProperties": false, "minItems": 1 } }, "required": [ "CardReplacementTimeline", "CardReplacementMetrics" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "CardReplacementTimeLineDetails" ] }, "AccountOpeningSummary": { "type": "object", "title": "AccountOpeningSummary", "properties": { "DocumentAndInfoURL": { "description": "URL provided by the organisation which redirects to the product (on live products only) available on an external website. There might be more than one product at a given URL.", "title": "DocumentAndInfoURL", "type": "string", "minLength": 1, "maxLength": 500 }, "AccountOpeningSummaryDetails": { "type": "array", "title": "AccountOpeningSummaryDetails", "items": { "type": "object", "properties": { "AccountOpeningContactMethod": { "title": "AccountOpeningContactMethod", "type": "string", "enum": [ "SendingDocumentElectronically", "Other", "OpenAccountByPost", "VisitBranchWithoutAppointment", "OpenAccountWithoutVisit" ] }, "ExecutionMethod": { "title": "ExecutionMethod", "type": "string", "enum": [ "InSomeCases", "NotApplicable", "No", "Yes" ] }, "OtherContactMethod": { "description": "Other coe set which is not available in the standard AccountOpeningContactMethod code set.", "type": "object", "title": "OtherContactMethod", "properties": { "Code": { "description": "The four letter Mnemonic used within an XML file to identify a code", "title": "Code", "type": "string", "pattern": "^\\w{0,4}$", "minLength": 0, "maxLength": 4 }, "Name": { "description": "Long name associated with the code", "title": "Name", "type": "string", "minLength": 1, "maxLength": 70 }, "Description": { "description": "Description to describe the purpose of the code", "title": "Description", "type": "string", "minLength": 1, "maxLength": 350 } }, "additionalProperties": false, "required": [ "Name", "Description" ] } }, "required": [ "AccountOpeningContactMethod", "ExecutionMethod" ] }, "additionalProperties": false, "minItems": 1 } }, "additionalProperties": false, "required": [ "DocumentAndInfoURL", "AccountOpeningSummaryDetails" ] } }, "required": [ "BrandName" ] }, "additionalProperties": false } }, "description": "Brand owned by an organisation", "type": "object" } } }, "required": [ "meta", "data" ], "additionalProperties": false } }, "400": { "description": "You have sent a request which could not be understood.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "400 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "400" ] }, "title": { "type": "string", "enum": [ "Bad request" ] }, "description": { "type": "string", "enum": [ "You have sent a request which could not be understood." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "408": { "description": "Your client has failed to submit a request, and a timeout has occurred.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "408 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "408" ] }, "title": { "type": "string", "enum": [ "Client timeout" ] }, "description": { "type": "string", "enum": [ "Your client has failed to submit a request, and a timeout has occurred." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "429": { "description": "You have requested this resource too often. Slow down.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "429 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "429" ] }, "title": { "type": "string", "enum": [ "Too many requests" ] }, "description": { "type": "string", "enum": [ "You have requested this resource too often. Slow down." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "500": { "description": "An error occurred on the server. No further information is available.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "500 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "500" ] }, "title": { "type": "string", "enum": [ "Internal server error" ] }, "description": { "type": "string", "enum": [ "An error occurred on the server. No further information is available." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "503": { "description": "The service is temporarily unavailable.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "503 Error object", "type": "object", "properties": { "status": { "type": "string", "enum": [ "503" ] }, "title": { "type": "string", "enum": [ "Service temporarily unavailable" ] }, "description": { "type": "string", "enum": [ "The service is temporarily unavailable." ] } }, "required": [ "status", "title", "description" ], "additionalProperties": false } }, "default": { "description": "A standard error response.", "headers": { "Strict-Transport-Security": { "type": "string", "description": "HTTPS strict transport security header" }, "X-Frame-Options": { "type": "string", "description": "Prevent this request from being loaded in any iframes", "default": "DENY" }, "X-Content-Type-Options": { "type": "string", "description": "Ensures each page has a content type and prevents browsers from doing MIME type sniffing", "default": "nosniff" }, "Status Code": { "type": "integer", "description": "The HTTP status code defining the error", "default": 400 } }, "schema": { "title": "Error object", "type": "object", "properties": { "status": { "description": "This corresponds to the HTTP status code", "type": "string" }, "title": { "description": "A short title of the type of error", "type": "string" }, "description": { "description": "Further details describing the error", "type": "string" } }, "required": [ "status", "title", "description" ], "additionalProperties": false } } } }, "head": { "tags": [ "FCSSRVM" ], "description": "Gets header information on the current set of `FCA Service Metrics` data", "parameters": [ { "name": "If-Modified-Since", "type": "string", "description": "Used for conditional request, to retrieve data only if modified since a given date", "in": "header", "required": false }, { "name": "If-None-Match", "type": "string", "description": "Used for conditional request, to retrieve data only if the given Etag value does not match", "in": "header", "required": false } ], "responses": { "default": { "description": "No response", "schema": { "title": "No response", "type": "object", "properties": {} } } } } } } }