nci-ats/fs-middlelayer-api

View on GitHub
mocks/basic.json

Summary

Maintainability
Test Coverage
{
    "swagger": "2.0",
    "info": {
        "description": "Mocks for Basic API",
        "title": "Mock API Documentation",
        "version": "0.0.1"
    },
    "tags": [
    ],
    "paths": {
        "/contact/lastname/{lastname}": {
            "get": {
                "tags": [
                    "Contact Person"
                ],
                "summary": "Contact Person",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                     {
                        "name": "lastname",
                        "in": "path",
                        "description": "lastname",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": [
                            {
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "LNAME, FNAME",
                                "contName": "fname lname",
                                "contactType": "PERSON",
                                "firstName": "Fname",
                                "lastName": "Lname",
                                "orgCode": null,
                                "orgType": null,
                                "personPrefix": "MS",
                                "securityId": "112233"
                            },
                            {
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "LNAME2, FNAME2",
                                "contName": "fname2 lname2",
                                "contactType": "PERSON",
                                "firstName": "Fname2",
                                "lastName": "Lname2",
                                "orgCode": null,
                                "orgType": null,
                                "personPrefix": "MS",
                                "securityId": "112221"
                            }]
                         }
                    }
                }
            }
        },
        "/contact/person": {
            "post": {
                "tags": [
                    "Contact Person"
                ],
                "summary": "Contact Person",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": {
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId":  "/[A-Z]{8} [A-Z]{8}/",
                                "contName": "Jane Roe",
                                "contactType": "PERSON",
                                "firstName": "Jane",
                                "lastName": "Roe",
                                "personPrefix": "MS"
                            }
                         }
                    }
                }
            }
        },
        "/contact/orgcode/{orgname}": {
            "get": {
                "tags": [
                    "Contact Organization"
                ],
                "summary": "Contact Organization",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                     {
                        "name": "orgname",
                        "in": "path",
                        "description": "orgname",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": [{
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "TEMP ORGANIZATION",
                                "contName": "Acme",
                                "contactType": "ORGANIZATION",
                                "firstName": null,
                                "lastName": null,
                                "orgCode": "INC",
                                "orgType": "CORPORATION",
                                "personPrefix": null,
                                "securityId": "110022"
                            },
                            {
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "TEMP ORGANIZATION2",
                                "contName": "Acme",
                                "contactType": "ORGANIZATION",
                                "firstName": null,
                                "lastName": null,
                                "orgCode": "INC",
                                "orgType": "CORPORATION",
                                "personPrefix": null,
                                "securityId": "112230"
                            },
                            {
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "TEMP ORGANIZATION",
                                "contName": "Acme",
                                "contactType": "ORGANIZATION",
                                "firstName": null,
                                "lastName": null,
                                "orgCode": "INC",
                                "orgType": "CORPORATION",
                                "personPrefix": null,
                                "securityId": "110024"
                            }]
                         }
                    }
                }
            }
        },
        "/contact/organization": {
            "post": {
                "tags": [
                    "Contact Organization"
                ],
                "summary": "Contact Organization",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": {
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "/[A-Z]{8} [A-Z]{8}/",
                                "contName": "Acme",
                                "contactType": "ORGANIZATION",
                                "firstName": null,
                                "lastName": null,
                                "orgCode": "INC",
                                "orgType": "CORPORATION",
                                "personPrefix": null,
                                "securityId": null
                            }
                         }
                    }
                }
            }
        },
        "/contact-address": {
            "post": {
                "tags": [
                    "Contact Address"
                ],
                "summary": "Contact Address",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": {
                                "addrCn": "987654321",
                                "addressType": "BILLING",
                                "address1": "1234 Main St",                                
                                "cityName": "Washington",
                                "stateCode": "DC",
                                "postalCode": "12345",
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "createdDate": "2016-06-04",                                
                                "programArea": "SUDS",
                                "securityId": "0102"                                
                            }
                         }
                    }
                }
            }
        },
        "/contact-phone": {
            "post": {
                "tags": [
                    "Contact Phone"
                ],
                "summary": "Contact Phone",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": {
                                "areaCode": "555",
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "createdDate": "2016-06-04",
                                "phoneNumber": "555-1234",
                                "phoneNumberType": "MOBILE",
                                "pnCn": "987654321",
                                "programArea": "SUDS",
                                "securityId": "0102"
                            }
                         }
                    }
                }
            }
        },
        "/application": {
            "post": {
                "tags": [
                    "Application"
                ],
                "summary": "Application",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": {
                                "accinstCn": "/[1-9]{1}[0-9]{9}/",
                                "epermitId": "0102000001",
                                "sudsId": "0102000001",
                                "securityId": "0102",
                                "managingOrg": "0102",
                                "adminOrg": "0102",
                                "purpose": "Permit Purpose",
                                "formName": "FS-2700-4I",
                                "formDesc": "Outfitting & Guiding Special Use Permit",
                                "holderCombKey": "/[1-9]{9}-[1-9]{4}[.][0-9]{6}/",
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "/[A-Z]{8} [A-Z]{8}/",
                                "contName": "/[A-Z]{1}[a-z]{2,7} [A-Z]{1}[a-z]{2,7}/",
                                "contactType": "PERSON",
                                "firstName": "/[A-Z]{1}[a-z]{2,7}/",
                                "lastName": "/[A-Z]{1}[a-z]{2,7}/",
                                "personPrefix": "MS",
                                "crExemptInd": "N"
                            }
                         }
                    }
                }
            }
        },
        "/application/{accinstCn}": {
            "get": {
                "tags": [
                    "Application"
                ],
                "summary": "Application",
                "description": "",
                "produces": [
                    "application/json"
                ],
                "parameters": [
                     {
                        "name": "accinstCn",
                        "in": "path",
                        "description": "accinstCn",
                        "required": true,
                        "type": "integer"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "Success",
                          "examples": {
                            "application/json": {
                                "accinstCn": "4882975010848",
                                "adminOrg": "0102",
                                "authOfficerName": "/[A-Z]{1}[a-z]{2,7} [A-Z]{1}[a-z]{2,7}/",
                                "authOfficerTitle": "/[A-Z]{1}[a-z]{2,7} [A-Z]{1}[a-z]{2,7}/",
                                "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                "contId": "PARTNER 2, PERONS1",
                                "contName": "/[A-Z]{8} [A-Z]{8}/",
                                "contactType": "PERSON",
                                "crExemptInd": "N",
                                "effectiveDate": null,
                                "epermitId": "/[0-9]{17}/",
                                "firstName": "perons1",
                                "formDesc": "Outfitting & Guiding Special Use Permit",
                                "formName": "FS-2700-4I ",
                                "holderCombKey": "/[1-9]{9}-[1-9]{4}[.][0-9]{6}/",
                                "lastName": "Partner 2",
                                "managingOrg": "0102",
                                "orgCode": null,
                                "orgType": null,
                                "personPrefix": null,
                                "purpose": "NEW Rafting on the Platt River-org",
                                "remarks": null,
                                "securityId": "0102",
                                "status": null,
                                "sudsId": "01021495567957048",
                                "addresses": [
                                {
                                    "addrCn": "565894",
                                    "address1": "123 Time Rd.",
                                    "address2": null,
                                    "address3": null,
                                    "addressSeq": null,
                                    "addressType": "BILLING",
                                    "cityName": "Gunston",
                                    "combKey": "/[1-9]{10}-[1-9]{6}/",
                                    "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                    "contId": "PARTNER 2, PERONS1",
                                    "contName": null,
                                    "contactType": "PERSON",
                                    "countryName": "United States of America",
                                    "createdDate": "2017-05-23",
                                    "email": "smoke@fs.red.us",
                                    "fmmiCustomerNumber": null,
                                    "modifiedDate": null,
                                    "postalCode": "21555",
                                    "programArea": "SUDS",
                                    "securityId": "0102",
                                    "stateCode": "MO"
                                }
                                ],
                                "phones": [
                                {
                                    "areaCode": "510",
                                    "combKey": "/[1-9]{13}-[1-9]{12}/",
                                    "contCn": "/[1-9]{1}[0-9]{3}[.][0-9]{6}/",
                                    "contId": "PARTNER 2, PERONS1",
                                    "contName": null,
                                    "contactType": "PERSON",
                                    "createdDate": "2017-05-23",
                                    "extension": "0",
                                    "internationalCode": null,
                                    "modifiedDate": null,
                                    "phoneNumber": "2224444",
                                    "phoneNumberType": "BUSINESS",
                                    "pnCn": "604373010848",
                                    "programArea": "SUDS",
                                    "restrictions": null,
                                    "securityId": "0102"
                                }
                                ],
                                "statuses": [],
                                "uses": [
                                {
                                    "acres": 0,
                                    "cn": "38076936010848",
                                    "feeCalculation": "O&G",
                                    "primaryFlag": "Y",
                                    "useCn": "170010343"
                                }
                                ]
                            }
                         }
                    }
                }
            }
        }
    }
}