Worked on the Revoke Enable Consent Request and Revoke Enable Consent Response
This commit is contained in:
@@ -106,6 +106,14 @@
|
||||
"description": "Find out more",
|
||||
"url": "https://www.simbrellang.net"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "RevokeEnableConsentRequest",
|
||||
"description": "Request to revoke or enable consent",
|
||||
"externalDocs": {
|
||||
"description": "Find out more",
|
||||
"url": "https://www.simbrellang.net"
|
||||
}
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
@@ -625,6 +633,53 @@
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/RevokeEnableConsent": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"RevokeEnableConsentRequest"
|
||||
],
|
||||
"summary": "Request to revoke or enable consent",
|
||||
"description": "This request is used to revoke or enable consent for a customer",
|
||||
"operationId": "revokeEnableConsentRequest",
|
||||
"requestBody": {
|
||||
"description": "Post JSON to revoke or enable consent",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/RevokeEnableConsentRequest"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": true
|
||||
},
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful operation",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/RevokeEnableConsentResponse"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid request parameters"
|
||||
},
|
||||
"404": {
|
||||
"description": "Resource not found"
|
||||
},
|
||||
"422": {
|
||||
"description": "Validation exception"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"apiKey": []
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
@@ -1961,6 +2016,98 @@
|
||||
"description": "Description of provided result code"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RevokeEnableConsentRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"transactionId",
|
||||
"fbnTransactionId",
|
||||
"customerId",
|
||||
"accountId",
|
||||
"processTime",
|
||||
"consentType",
|
||||
"countryId"
|
||||
],
|
||||
"properties": {
|
||||
"transactionId": {
|
||||
"type": "string",
|
||||
"example": "T0014",
|
||||
"description": "Unique identifier of transaction in Simbrella system"
|
||||
},
|
||||
"fbnTransactionId": {
|
||||
"type": "string",
|
||||
"example": "20171209232177",
|
||||
"description": "Unique id of the transaction received from FBN in CustomerConsentRequest"
|
||||
},
|
||||
"customerId": {
|
||||
"type": "string",
|
||||
"example": "CN621868",
|
||||
"description": "Unique identifier of a user"
|
||||
},
|
||||
"accountId": {
|
||||
"type": "string",
|
||||
"example": "2017821799",
|
||||
"description": "Specific identifier of a user's account"
|
||||
},
|
||||
"processTime": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"example": "2019-10-18 14:26:21.063",
|
||||
"description": "Date and time when consent request was processed"
|
||||
},
|
||||
"consentType": {
|
||||
"type": "string",
|
||||
"example": "Revoke",
|
||||
"description": "'Enable' or 'Revoke'"
|
||||
},
|
||||
"countryId": {
|
||||
"type": "string",
|
||||
"example": "01",
|
||||
"description": "Set to static value '01'"
|
||||
},
|
||||
"comment": {
|
||||
"type": "string",
|
||||
"example": "Testing RevokeEnableConsentRequest",
|
||||
"description": "Any additional comment for consent operation"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RevokeEnableConsentResponse": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"$type",
|
||||
"customerId",
|
||||
"accountId",
|
||||
"resultCode",
|
||||
"resultDescription"
|
||||
],
|
||||
"properties": {
|
||||
"$type": {
|
||||
"type": "string",
|
||||
"example": "RevokeEnableConsentResponse",
|
||||
"description": "Value is fixed to 'RevokeEnableConsentResponse'"
|
||||
},
|
||||
"customerId": {
|
||||
"type": "string",
|
||||
"example": "CN621868",
|
||||
"description": "Unique identifier of a user"
|
||||
},
|
||||
"accountId": {
|
||||
"type": "string",
|
||||
"example": "2017821799",
|
||||
"description": "Specific identifier of a user's account"
|
||||
},
|
||||
"resultCode": {
|
||||
"type": "string",
|
||||
"example": "00",
|
||||
"description": "Result code of executed transaction"
|
||||
},
|
||||
"resultDescription": {
|
||||
"type": "string",
|
||||
"example": "Success",
|
||||
"description": "Description of provided result code"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securitySchemes": {
|
||||
|
||||
Reference in New Issue
Block a user