{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/wordline/main/json-schema/wordline-api-response-entity-generate-card-letter-response-schema.json", "title": "ApiResponseEntityGenerateCardLetterResponse", "description": "Generate Card Letter Response", "x-generated": "2026-10-10", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/wordline-card-letter-api-openapi.yml#/components/schemas/ApiResponseEntityGenerateCardLetterResponse", "x-wl-api-response": true, "type": "object", "required": [ "responseMetadata" ], "properties": { "responseMetadata": { "description": "Response metadata", "allOf": [ { "$ref": "#/$defs/ResponseMetadata" } ] }, "data": { "description": "Response data", "allOf": [ { "$ref": "#/$defs/GenerateCardLetterResponse" } ] } }, "$defs": { "GenerateCardLetterResponse": { "type": "object", "required": [ "letterIdentifier", "name", "generationDate" ], "properties": { "letterIdentifier": { "description": "Refer to Letter.letterIdentifier", "allOf": [ { "$ref": "#/$defs/LetterIdentifier" } ] }, "name": { "type": "string", "description": "Refer to Letter.name" }, "generationDate": { "type": "string", "format": "date-time", "description": "Refer to Letter.generationDate" } }, "title": "GenerateCardLetterResponse" }, "LetterIdentifier": { "type": "object", "properties": { "letterId": { "type": "string", "description": "Unique ID of the letter, generated in the system" } }, "title": "LetterIdentifier" }, "Links": { "type": "object", "required": [ "self" ], "properties": { "self": { "type": "string", "description": "Service method URL" }, "next": { "type": "string", "description": "URL pagination query parameter next page" } }, "title": "Links" }, "ResponseMetadata": { "type": "object", "required": [ "correlationId", "responseDateTime", "statusCode", "statusMessage" ], "properties": { "correlationId": { "type": "string", "description": "Correlation Identifier" }, "links": { "description": "Metadata Links", "allOf": [ { "$ref": "#/$defs/Links" } ] }, "statusMessage": { "type": "string", "description": "Executed REST API status message" }, "statusCode": { "type": "integer", "format": "int32", "description": "HTTP status code" }, "responseDateTime": { "type": "string", "description": "Timestamp when response date was generated" }, "timeTakenMs": { "type": "integer", "format": "int64", "description": "Wall clock time required from service to generate the response" } }, "title": "ResponseMetadata" } } }