Added Data8 connector (#35)
This commit is contained in:
Matt Beard
ShyamSunder90
Родитель
3a5650a39f
Коммит
6d6065d3c7
|
|
@ -0,0 +1,756 @@
|
|||
{
|
||||
"basePath": "/",
|
||||
"consumes": [],
|
||||
"definitions": {},
|
||||
"host": "webservices.data-8.co.uk",
|
||||
"info": {
|
||||
"description": "Data8 helps you build confidence in your data. We can save you money by cleaning and enriching both your existing data, as well as ensuring only the highest quality data goes in at the point of entry, leaving you to concentrate on targeting and communicating to the right customers.\n\nFor more information about Data8 and how to get started, please visit https://www.data-8.co.uk/flow.",
|
||||
"title": "Data8 Data Enrichment",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"parameters": {},
|
||||
"paths": {
|
||||
"/BankAccountValidation/IsValid.json": {
|
||||
"post": {
|
||||
"description": "Check if a sort code and bank account number are valid.",
|
||||
"operationId": "IsValidBankAccount",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"bankAccountNumber": {
|
||||
"description": "The bank account number you wish to validate",
|
||||
"title": "Bank Account Number",
|
||||
"type": "string"
|
||||
},
|
||||
"sortCode": {
|
||||
"description": "The sort code you wish to validate",
|
||||
"title": "Sort Code",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"sortCode"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"AcceptsBACSPayments": {
|
||||
"description": "Indicates if the bank branch can accept payments made through the BACS system.",
|
||||
"title": "Accepts BACS Payments",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsBuildingSocietyCreditTransactions": {
|
||||
"description": "Indicates if the bank branch can accept credits from building societies.",
|
||||
"title": "Accepts Building Society Credit Transactions",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsCHAPSPayments": {
|
||||
"description": "Indicates if the bank branch can accept payments made through the CHAPS system.",
|
||||
"title": "Accepts CHAPS Payments",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsCheques": {
|
||||
"description": "Indicates if the bank branch can accept payments made by cheque.",
|
||||
"title": "Accepts Cheques",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsDirectCreditTransactions": {
|
||||
"description": "Indicates if the bank branch can accept direct credit payments.",
|
||||
"title": "Accepts Direct Credit Transactions",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsDirectDebitInstructionTransactions": {
|
||||
"description": "Indicates if the bank branch can accept direct debit instructions.",
|
||||
"title": "Accepts Direct Debit Instruction Transactions",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsDirectDebitTransactions": {
|
||||
"description": "Indicates if the bank branch can accept direct debit payments.",
|
||||
"title": "Accepts Direct Debit Transactions",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsDividendInterestPaymentTransactions": {
|
||||
"description": "Indicates if the bank branch can accept dividend interest payments.",
|
||||
"title": "Accepts Dividend Interest Payment Transactions",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsFasterPayments": {
|
||||
"description": "Indicates if the bank branch can accept payments made through the Faster Payments system.",
|
||||
"title": "Accepts Faster Payments",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AcceptsUnpaidChequeClaimTransactions": {
|
||||
"description": "Indicates if the bank branch can accept claims for unpaid cheques.",
|
||||
"title": "Accepts Unpaid Cheque Claim Transactions",
|
||||
"type": "boolean"
|
||||
},
|
||||
"AccountNumber": {
|
||||
"description": "The account number that has been validated.",
|
||||
"title": "Account Number",
|
||||
"type": "string"
|
||||
},
|
||||
"Address": {
|
||||
"description": "Address",
|
||||
"properties": {
|
||||
"Address": {
|
||||
"description": "The address of the bank branch indicated by the sort code.",
|
||||
"properties": {
|
||||
"Lines": {
|
||||
"description": "Lines",
|
||||
"items": {
|
||||
"title": "Address Lines",
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"title": "Address",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"BICCode": {
|
||||
"description": "The BIC code of the bank branch indicated by the sort code.",
|
||||
"title": "BIC Code",
|
||||
"type": "string"
|
||||
},
|
||||
"BranchName": {
|
||||
"description": "The name of the bank branch indicated by the sort code.",
|
||||
"title": "Branch Name",
|
||||
"type": "string"
|
||||
},
|
||||
"FullBankName": {
|
||||
"description": "The full name for the bank indicated by the sort code.",
|
||||
"title": "Full Bank Name",
|
||||
"type": "string"
|
||||
},
|
||||
"IBAN": {
|
||||
"description": "The IBAN code of the bank account indicated by the sort code and account number.",
|
||||
"title": "IBAN",
|
||||
"type": "string"
|
||||
},
|
||||
"ShortBankName": {
|
||||
"description": "A short name for the bank indicated by the sort code.",
|
||||
"title": "Short Bank Name",
|
||||
"type": "string"
|
||||
},
|
||||
"SortCode": {
|
||||
"description": "The sort code that has been validated.",
|
||||
"title": "Sort Code",
|
||||
"type": "string"
|
||||
},
|
||||
"Status": {
|
||||
"description": "Status",
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Valid": {
|
||||
"description": "Indicates if the incoming sort code and bank account number could be validated.",
|
||||
"title": "Valid",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Validate Bank Account Information"
|
||||
}
|
||||
},
|
||||
"/CTPS/IsCallable.json": {
|
||||
"post": {
|
||||
"description": "Checks if a telephone number is registered on the CTPS or not.",
|
||||
"operationId": "IsCallableCTPS",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"number": {
|
||||
"description": "The telephone number you wish to CTPS check",
|
||||
"title": "Telephone Number",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"number"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"Callable": {
|
||||
"description": "Returns a boolean value letting you know if it's callable. If false, the number is currently on the CTPS.",
|
||||
"title": "Is Callable",
|
||||
"type": "boolean"
|
||||
},
|
||||
"Status": {
|
||||
"description": "Status",
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TelephoneNumber": {
|
||||
"description": "If populated, the telephone number is callable and null if not",
|
||||
"title": "Telephone Number",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "CTPS Check"
|
||||
}
|
||||
},
|
||||
"/EmailValidation/IsValid.json": {
|
||||
"post": {
|
||||
"description": "Checks to see if an inputted email address is valid to receive email",
|
||||
"operationId": "IsValidEmail",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"email": {
|
||||
"description": "The email address you wish to validate",
|
||||
"title": "Email Address",
|
||||
"type": "string"
|
||||
},
|
||||
"level": {
|
||||
"description": "The level to which you wish to validate - please check https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid for more information",
|
||||
"enum": [
|
||||
"Syntax",
|
||||
"MX",
|
||||
"Server",
|
||||
"Address"
|
||||
],
|
||||
"title": "Validation Level",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"email",
|
||||
"level"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"Result": {
|
||||
"description": "Contains a status code indicating if the email address could be validated. For more information on the possible status code, please read https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid",
|
||||
"title": "Result",
|
||||
"type": "string"
|
||||
},
|
||||
"Status": {
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Validate Email Address"
|
||||
}
|
||||
},
|
||||
"/InternationalTelephoneValidation/IsValid.json": {
|
||||
"post": {
|
||||
"description": "Checks to see if an inputted email address is valid to receive email",
|
||||
"operationId": "IsValidTelephone",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"defaultCountry": {
|
||||
"description": "Formatted as numbers i.e. 44 for UK",
|
||||
"title": "Default Country Code",
|
||||
"type": "string"
|
||||
},
|
||||
"options": {
|
||||
"description": "options",
|
||||
"properties": {
|
||||
"UseLineValidation": {
|
||||
"description": "If set to true then the service will use Data8 LandlineValidation on any number it recognises as a UK landline number and InternationalTelephoneValidation on all other numbers. Any validation call will be debited either an InternationalTelephoneValidation credit or a LandlineValidation credit accordingly so please ensure you have LandlineValidation credits available before using this option. The option defaults to false.",
|
||||
"title": "Use Line Validation",
|
||||
"type": "boolean"
|
||||
},
|
||||
"UseMobileValidation": {
|
||||
"description": "If set to true then the service will use Data8 MobileValidation on any number it recognises as a mobile number and InternationalTelephoneValidation on all other numbers. Any validation call will be debited either an InternationalTelephoneValidation credit or a MobileValidation credit accordingly so please ensure you have MobileValidation credits available before using this option. The option defaults to false.",
|
||||
"title": "Use Mobile Validation",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"telephoneNumber": {
|
||||
"description": "The number you want to validate",
|
||||
"title": "Telephone Number",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"telephoneNumber",
|
||||
"defaultCountry"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"Result": {
|
||||
"description": "Result",
|
||||
"properties": {
|
||||
"CountryCode": {
|
||||
"description": "Country ISO2 code of the telephone number",
|
||||
"title": "Country Code",
|
||||
"type": "string"
|
||||
},
|
||||
"CountryName": {
|
||||
"description": "Country name of the telephone number",
|
||||
"title": "Country Name",
|
||||
"type": "string"
|
||||
},
|
||||
"Location": {
|
||||
"description": "Current location of the telephone number if available",
|
||||
"title": "Location",
|
||||
"type": "string"
|
||||
},
|
||||
"NumberType": {
|
||||
"description": "Specifies the type of the number provided i.e. Landline or Mobile",
|
||||
"title": "Number Type",
|
||||
"type": "string"
|
||||
},
|
||||
"Provider": {
|
||||
"description": "The network provider of the telephone number",
|
||||
"title": "Provider",
|
||||
"type": "string"
|
||||
},
|
||||
"TelephoneNumber": {
|
||||
"description": "The inputted telephone number formatted",
|
||||
"title": "Telephone Number",
|
||||
"type": "string"
|
||||
},
|
||||
"ValidationLevel": {
|
||||
"description": "The level of validation found for the phone number.",
|
||||
"title": "Validation Level",
|
||||
"type": "string"
|
||||
},
|
||||
"ValidationResult": {
|
||||
"description": "The simple result for the validation of the telephone number",
|
||||
"title": "Validation Result",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Status": {
|
||||
"description": "Status",
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Validate Telephone Number"
|
||||
}
|
||||
},
|
||||
"/Postcoder/CleanAddress.json": {
|
||||
"post": {
|
||||
"description": "Formats, verifies and corrects a given address into a full formatted address.",
|
||||
"operationId": "CleanAddress",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"address": {
|
||||
"description": "address",
|
||||
"properties": {
|
||||
"Lines": {
|
||||
"description": "Lines",
|
||||
"items": {
|
||||
"description": "",
|
||||
"title": "Address Lines",
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"Lines"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"options": {
|
||||
"description": "options",
|
||||
"properties": {
|
||||
"Country": {
|
||||
"description": "If DetectCountry is set to true, this is taken as additional user input alongside the address to influence the country detection function. The format of this is not enforced, so could be provided as \"US\", \"USA\" or \"United States\"",
|
||||
"title": "Country",
|
||||
"type": "string"
|
||||
},
|
||||
"DefaultCountryCode": {
|
||||
"description": "an ISO 2 character code for the country to assume the address is in unless otherwise specified. This defaults to GB.",
|
||||
"title": "Default Country Code",
|
||||
"type": "string"
|
||||
},
|
||||
"DetectCountry": {
|
||||
"description": "Set to true to attempt to automatically detect the country from the provided address information, possibly overriding the default country",
|
||||
"title": "Auto Detect Country",
|
||||
"type": "boolean"
|
||||
},
|
||||
"IncludeCountry": {
|
||||
"description": "Includes the CountryName field in the main part of the result",
|
||||
"title": "Include Country",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"address"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"CountryName": {
|
||||
"description": "Contains the name of the country the address is in.",
|
||||
"title": "Country Name",
|
||||
"type": "string"
|
||||
},
|
||||
"MatchLevel": {
|
||||
"description": "Contains a MatchLevel to indicate how well the address matched to PAF. Possible values are OK_Unchanged, OK_Corrected, NOK_Building, NOK_Street, NOK_Town, NOK_NoMatch",
|
||||
"title": "Match Level",
|
||||
"type": "string"
|
||||
},
|
||||
"Result": {
|
||||
"description": "Result",
|
||||
"properties": {
|
||||
"Address": {
|
||||
"description": "Address",
|
||||
"properties": {
|
||||
"Lines": {
|
||||
"description": "Lines",
|
||||
"items": {
|
||||
"title": "Address Lines",
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"title": "Address Lines",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Status": {
|
||||
"description": "Status",
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Clean Address"
|
||||
}
|
||||
},
|
||||
"/SalaciousName/IsUnusableName.json": {
|
||||
"post": {
|
||||
"description": "Using this action, you can check if a name is a real usable name or whether it is salacious, random or blank.",
|
||||
"operationId": "IsUsableName",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"name": {
|
||||
"description": "name",
|
||||
"properties": {
|
||||
"Forename": {
|
||||
"description": "The first name of the full name",
|
||||
"title": "First name",
|
||||
"type": "string"
|
||||
},
|
||||
"MiddleName": {
|
||||
"description": "The middle name of the full name",
|
||||
"title": "Middle name",
|
||||
"type": "string"
|
||||
},
|
||||
"Surname": {
|
||||
"description": "The last name of the full name",
|
||||
"title": "Last name",
|
||||
"type": "string"
|
||||
},
|
||||
"Title": {
|
||||
"description": "The title of the name",
|
||||
"title": "Title",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"Result": {
|
||||
"description": "A blank value indiciates the name is a usable name. If a value is returned it will be one of the following: \"IncompleteName\", \"RandomName\" or \"SalaciousName\"",
|
||||
"enum": [
|
||||
"",
|
||||
"IncompleteName",
|
||||
"RandomName",
|
||||
"SalaciousName"
|
||||
],
|
||||
"title": "Result",
|
||||
"type": "string"
|
||||
},
|
||||
"Status": {
|
||||
"description": "Status",
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Check Usable Name"
|
||||
}
|
||||
},
|
||||
"/TPS/IsCallable.json": {
|
||||
"post": {
|
||||
"description": "Checks if a telephone number is registered on the TPS or not.",
|
||||
"operationId": "IsCallableTPS",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"properties": {
|
||||
"number": {
|
||||
"description": "The telephone number you want to TPS check",
|
||||
"title": "Telephone Number",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"number"
|
||||
],
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"schema": {
|
||||
"properties": {
|
||||
"Callable": {
|
||||
"description": "Returns a boolean value letting you know if it's callable. If false, the number is currently on the TPS.",
|
||||
"title": "Is Callable",
|
||||
"type": "boolean"
|
||||
},
|
||||
"Status": {
|
||||
"description": "Status",
|
||||
"properties": {
|
||||
"CreditsRemaining": {
|
||||
"description": "Data8 Credits Remaining for the called service",
|
||||
"title": "Credits Remaining",
|
||||
"type": "integer"
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"description": "Returned Error Message, if any",
|
||||
"title": "Error Message",
|
||||
"type": "string"
|
||||
},
|
||||
"Success": {
|
||||
"description": "Flag to determine if the request to Data8 succeeded, regardless of result",
|
||||
"title": "Success",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"TelephoneNumber": {
|
||||
"description": "Returns the telephone number if callable, null if not.",
|
||||
"title": "Telephone Number",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "TPS Check"
|
||||
}
|
||||
}
|
||||
},
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"responses": {},
|
||||
"schemes": [
|
||||
"https"
|
||||
],
|
||||
"security": [],
|
||||
"securityDefinitions": {
|
||||
"api_key": {
|
||||
"in": "query",
|
||||
"name": "key",
|
||||
"type": "apiKey"
|
||||
}
|
||||
},
|
||||
"swagger": "2.0",
|
||||
"tags": []
|
||||
}
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
{
|
||||
"properties": {
|
||||
"capabilities": [
|
||||
"actions"
|
||||
],
|
||||
"connectionParameters": {
|
||||
"api_key": {
|
||||
"type": "securestring",
|
||||
"uiDefinition": {
|
||||
"constraints": {
|
||||
"clearText": false,
|
||||
"required": "true",
|
||||
"tabIndex": 2
|
||||
},
|
||||
"description": "The API Key for this api",
|
||||
"displayName": "API Key",
|
||||
"tooltip": "Provide your API Key"
|
||||
}
|
||||
}
|
||||
},
|
||||
"iconBrandColor": "#1973ae"
|
||||
}
|
||||
}
|
||||
Загрузка…
Ссылка в новой задаче