{ "swagger": "2.0", "info": { "version": "1.0.0", "title": "PhoneSearch", "description": "Append phone number(s) to a submitted name/address, address or name/partial address" }, "host": "apitest.microbilt.com", "basePath": "/PhoneSearch", "schemes": [ "https" ], "paths": { "/": { "post": { "description": "Get report associated with phone", "summary": "Gets Phone Search", "operationId": "GetReport", "parameters": [ { "name":"Content-Type", "description":"Specifies the format of the request", "in":"header", "required": true, "type":"string", "enum": [ "application/json","application/xml" ] }, { "name":"Accept", "description":"Specifies the format of the response", "in":"header", "required": true, "type":"string", "enum": [ "application/json","application/xml" ] }, { "name": "body", "in": "body", "required": true, "description": "Gets Phone Search", "schema": { "$ref": "#/definitions/PhoneSearchRq" }, "x-example": { "application/json": [ { "name": "Test PhoneSearch", "body": "{\"Name\":{\"FirstName\":\"John\",\"MiddleName\":\"Percival\",\"LastName\":\"Smith\"},\"Address\":{\"Addr1\":\"1640 Airport Rd. Suite 115\",\"City\":\"Kennesaw\",\"State\":\"GA\",\"Zip\":\"30144\"}}" } ], "application/xml": [ { "name": "Test PhoneSearch", "body": "JohnPercivalSmith

1640 Airport Rd. Suite 115KennesawGA30144

" } ] } } ], "responses": { "200": { "description": "GetReport", "schema": { "$ref": "#/definitions/PhoneSearchRs" }, "examples": {} } }, "security": [{ "oauth": [] } ] } } }, "securityDefinitions": { "oauth": { "type": "oauth2", "authorizationUrl": "https://apitest.microbilt.com/OAuth/GetAccessToken?grant_type=client_credentials", "tokenUrl": "https://apitest.microbilt.com/OAuth/GetAccessToken?grant_type=client_credentials", "flow": "accessCode", "scopes": {} } }, "definitions": { "PhoneSearchRq": { "title": "PhoneSearchRq", "type": "object", "properties": { "Name": { "$ref": "#/definitions/Name" }, "Address": { "$ref": "#/definitions/Address" } } }, "Name": { "type": "object", "properties": { "FirstName": { "type": "string" }, "MiddleName": { "type": "string" }, "LastName": { "type": "string" } } }, "Address": { "type": "object", "properties": { "Addr1": { "type": "string" }, "Addr2": { "type": "string" }, "StreetName": { "type": "string" }, "StreetNum": { "type": "string" }, "Apt": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "Zip": { "type": "string" }, "County": { "type": "string" }, "Country": { "type": "string" } } }, "PersonInfo": { "type": "object", "properties": { "PersonName": { "$ref": "#/definitions/PersonName" }, "ContactInfo": { "type": "array", "items": { "$ref": "#/definitions/ContactInfo" } } } }, "PersonName": { "type": "object", "properties": { "FirstName": { "type": "string", "example": "John", "description": "First name" }, "MiddleName": { "type": "string", "example": "Percival", "description": "Middle name" }, "LastName": { "type": "string", "example": "Smith", "description": "Last name" } } }, "ContactInfo": { "type": "object", "properties": { "PostAddr": { "$ref": "#/definitions/PostAddr" } } }, "PostAddr": { "type": "object", "properties": { "Addr1": { "type": "string", "example": "1641 Airport Rd. Suite 115", "description": "First address" }, "Addr2": { "type": "string", "example": "", "description": "Second address" }, "Apt": { "type": "string", "example": "115", "description": "Apartment number/office number" }, "StreetName": { "type": "string", "example": "Airport", "description": "Street name" }, "StreetNum": { "type": "string", "example": "1640", "description": "Street number" }, "StreetType": { "type": "string", "example": "Rd.", "description": "Street type" }, "City": { "type": "string", "example": "Kennesaw", "description": "City" }, "StateProv": { "type": "string", "example": "GA", "description": "State or Province" }, "PostalCode": { "type": "string", "example": "30144", "description": "Postal code" }, "Country": { "type": "string", "example": "US", "description": "Country" } } }, "PhoneSearchRs": { "title": "PhoneSearchRs", "type": "object", "properties": { "MsgRsHdr": { "$ref": "#/definitions/MsgRsHdr" }, "PhoneNumber": { "description": "Phone Number", "type": "string" }, "Message": { "description": "", "type": "array", "items": { "$ref": "#/definitions/Message" } } } }, "MsgRsHdr": { "title": "MsgRsHdr", "type": "object", "properties": { "RqUID": { "description": "", "type": "string" }, "Status": { "$ref": "#/definitions/Status" } } }, "Status": { "title": "Status", "type": "object", "properties": { "StatusCode": { "description": "", "type": "integer", "format": "int64" }, "ServerStatusCode": { "description": "", "type": "string" }, "Severity": { "$ref": "#/definitions/Severity" }, "StatusDesc": { "description": "", "type": "string" }, "AdditionalStatus": { "description": "", "type": "array", "items": { "$ref": "#/definitions/AdditionalStatus" } } } }, "Severity": { "title": "Severity", "example": 0, "type": "integer", "format": "int32", "enum": [ "0", "1", "2" ] }, "AdditionalStatus": { "title": "AdditionalStatus", "type": "object", "properties": { "StatusCode": { "description": "", "type": "integer", "format": "int64" }, "ServerStatusCode": { "description": "", "type": "string" }, "Severity": { "$ref": "#/definitions/Severity" }, "StatusDesc": { "description": "", "type": "string" } } }, "Message": { "title": "Message", "type": "object", "properties": { "MsgClass": { "description": "", "type": "string" }, "MsgCode": { "description": "", "type": "string" }, "Text": { "description": "", "type": "string" }, "Source": { "description": "", "type": "string" }, "EffDt": { "description": "", "type": "string", "format": "date-time" } } } } }