{
    "basePath": "http://api.basetax.co.uk/v4",
    "swaggerVersion": "1.2",
    "apiVersion": "1.0.0",
    "resourcePath": "/non-residents",
    "apis": [
        {
            "path": "/non-residents",
            "operations": [
                {
                    "method": "GET",
                    "summary": "Get all nonResidents",
                    "nickname": "nonResidents",
                    "responseMessages": [
                        {
                            "code": 400,
                            "message": "Invalid request params"
                        },
                        {
                            "code": 401,
                            "message": "Caller is not authenticated"
                        },
                        {
                            "code": 404,
                            "message": "Resource not found"
                        }
                    ]
                },
                {
                    "method": "POST",
                    "summary": "Create a nonResident",
                    "nickname": "nonResident",
                    "parameters": [
                        {
                            "paramType": "body",
                            "name": "body",
                            "type": "NonResident",
                            "required": true,
                            "description": "json body"
                        }
                    ],
                    "responseMessages": [
                        {
                            "code": 400,
                            "message": "Invalid request params"
                        },
                        {
                            "code": 401,
                            "message": "Caller is not authenticated"
                        },
                        {
                            "code": 404,
                            "message": "Resource not found"
                        }
                    ]
                }
            ]
        },
        {
            "path": "/non-residents/{id}",
            "operations": [
                {
                    "method": "GET",
                    "summary": "Get one non resident",
                    "nickname": "nonResident",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "id",
                            "type": "string",
                            "required": true,
                            "description": "Id"
                        }
                    ],
                    "responseMessages": [
                        {
                            "code": 400,
                            "message": "Invalid request params"
                        },
                        {
                            "code": 401,
                            "message": "Caller is not authenticated"
                        },
                        {
                            "code": 404,
                            "message": "Resource not found"
                        }
                    ]
                },
                {
                    "method": "PUT",
                    "summary": "Update a nonResident",
                    "nickname": "nonResident",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "id",
                            "type": "string",
                            "required": true,
                            "description": "Id"
                        },
                        {
                            "paramType": "body",
                            "name": "body",
                            "type": "NonResident",
                            "required": true,
                            "description": "json body"
                        }
                    ],
                    "responseMessages": [
                        {
                            "code": 400,
                            "message": "Invalid request params"
                        },
                        {
                            "code": 401,
                            "message": "Caller is not authenticated"
                        },
                        {
                            "code": 404,
                            "message": "Resource not found"
                        }
                    ]
                },
                {
                    "method": "DELETE",
                    "summary": "Delete a nonResident",
                    "nickname": "nonResident",
                    "parameters": [
                        {
                            "paramType": "path",
                            "name": "id",
                            "type": "string",
                            "required": true,
                            "description": "Id"
                        }
                    ],
                    "responseMessages": [
                        {
                            "code": 400,
                            "message": "Invalid request params"
                        },
                        {
                            "code": 401,
                            "message": "Caller is not authenticated"
                        },
                        {
                            "code": 404,
                            "message": "Resource not found"
                        }
                    ]
                }
            ]
        }
    ],
    "models": {
        "NonResident": {
            "id": "NonResident",
            "required": [
                "tax_return_id",
                "tax_year_id",
                "user_id"
            ],
            "properties": {
                "user_id": {
                    "type": "integer",
                    "defaultValue": 4
                },
                "tax_year_id": {
                    "type": "integer",
                    "defaultValue": 5
                },
                "tax_return_id": {
                    "type": "integer",
                    "defaultValue": 24004
                },
                "NRD1": {
                    "type": "boolean"
                },
                "NRD2": {
                    "type": "boolean"
                },
                "NRD3": {
                    "type": "boolean"
                },
                "NRD3_1": {
                    "type": "boolean"
                },
                "NRD4": {
                    "type": "boolean"
                },
                "NRD5": {
                    "type": "boolean"
                },
                "NRD6": {
                    "type": "string",
                    "format": "date",
                    "defaultValue": "2016-12-24"
                },
                "NRD7": {
                    "type": "boolean"
                },
                "NRD8": {
                    "type": "boolean"
                },
                "NRD9": {
                    "type": "boolean"
                },
                "NRD10": {
                    "type": "integer",
                    "defaultValue": 100
                },
                "NRD11": {
                    "type": "integer",
                    "defaultValue": 100
                },
                "NRD12": {
                    "type": "integer",
                    "defaultValue": 100
                },
                "NRD13": {
                    "type": "integer",
                    "defaultValue": 100
                },
                "NRD14": {
                    "type": "integer",
                    "defaultValue": 100
                },
                "NRD15": {
                    "type": "boolean"
                },
                "NRD16": {
                    "type": "boolean"
                },
                "NRD17A": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD17B": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD17C": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD18A": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD18B": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD19A": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD19B": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD20": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD21": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD22": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD23": {
                    "type": "boolean"
                },
                "NRD24": {
                    "type": "boolean"
                },
                "NRD25": {
                    "type": "string",
                    "format": "date",
                    "defaultValue": "2016-12-24"
                },
                "NRD26": {
                    "type": "boolean"
                },
                "NRD27": {
                    "type": "string",
                    "format": "date",
                    "defaultValue": "2016-12-24"
                },
                "NRD28": {
                    "type": "boolean"
                },
                "NRD29": {
                    "type": "boolean"
                },
                "NRD30": {
                    "type": "boolean"
                },
                "NRD31": {
                    "type": "boolean"
                },
                "NRD32": {
                    "type": "boolean"
                },
                "NRD33": {
                    "type": "boolean"
                },
                "NRD34": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD35": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD36": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD37": {
                    "type": "boolean"
                },
                "NRD38": {
                    "type": "float",
                    "defaultValue": 12.44
                },
                "NRD38A": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD38B": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD38C": {
                    "type": "string",
                    "defaultValue": "GBR"
                },
                "NRD39": {
                    "type": "boolean"
                },
                "NRD40": {
                    "type": "string",
                    "defaultValue": "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
                }
            }
        }
    },
    "produces": [
        "application/json"
    ]
}