Searching for Contractors and Permits

Requests should be initiated to the following url https://permits.himaintenance.io/
Header should contain x-api-key parameter which can be requested here

Contractor Search URL

/POST

https://permits.himaintenance.io/contractor-api/v1/initiate-search

Accepted Parameters for initiate-search API
  • contractor_organization
Status for Searched Contractor URL

/GET

https://permits.himaintenance.io/contractor-api/v1/get-status/

Accepted Parameters for get-status API
  • reference_id
Get Contractor Data for Searched Contractor URL

/GET

https://permits.himaintenance.io/contractor-api/v1/get_contractor_data/

Accepted Parameters for get_contractor_data API
  • contractor_ref_id
Get Permits for Searched Contractor URL

/GET

https://permits.himaintenance.io/contractor-api/v1/get_permits/

Accepted Parameters for get_permits API
  • contractor_ref_id

Scenario 1 - Contractor Found

/POST

https://permits.himaintenance.io/contractor-api/v1/initiate-search

Body
{ "contractor_organization": "SIEMENS" }
Response Body with status code
200
{
    "reference_id": "7465a9b2af6e4bfdb2015d288fbe8390",
    "contractor_organization": "siemens",
    "status": "IN_PROGRESS"
}

/GET

https://permits.himaintenance.io/contractor-api/v1/get-status/?reference_id=7465a9b2af6e4bfdb2015d288fbe8390

Query Param Value
reference_id 7465a9b2af6e4bfdb2015d288fbe8390
Response Body with status code
200
{
    "searched_organization": "siemens",
    "status": "CONTRACTOR_FOUND",
    "search_result": [
        {
            "state": "TX",
            "match_score": 1.0,
            "company_name": "SIEMENS",
            "contractor_ref_id": "7465a9b2af6e4bfdb2015d288fbe8390-CTX00352916",
            "contractor_address": "1335 Ridgeland Pkwy Alpharetta GA 30004-0728"
        },
        {
            "state": "CA",
            "match_score": 1.0,
            "company_name": "SIEMENS SIEMENS",
            "contractor_ref_id": "7465a9b2af6e4bfdb2015d288fbe8390-CCA00196756",
            "contractor_address": ""
        }
    ]
}

/GET

https://permits.himaintenance.io/contractor-api/v1/get_contractor_data/?contractor_ref_id=7465a9b2af6e4bfdb2015d288fbe8390-CTX00352916

Query Param Value
contractor_ref_id 7465a9b2af6e4bfdb2015d288fbe8390-CTX00352916
Response Body with status code
200
    {
        "contractor_ref_id": "7465a9b2af6e4bfdb2015d288fbe8390-CTX00352916",

        "result": {
            "contractor_id": "CTX00352916",
            "company_name": "SIEMENS",
            "contact_name": "Yalcin Yalcinkaya",
            "contractor_email": "yalcin.yalcinkaya@siemens.com",
            "contractor_phone": "6786913946.0",
            "contractor_address": "1335 Ridgeland Pkwy Alpharetta GA 30004-0728",
            "county": "Forsyth",
            "license_number": null,
            "license_expiry_date": null,
            "sic_code": "171131",
            "sic_description": null,
            "naics_code": null,
            "naic_description": null,
            "insurance_information": null,
            "website": null,
            "number_of_employee": "1 To 4",
            "annual_revenue": null,
            "annual_sales": "$500,000 To $1 Million",
            "contact_role": "Comm Engineer",
            "direct_phone_number": null,
            "industry": "Energy Management Systems & Products"
        }
    }

/GET

https://permits.himaintenance.io/contractor-api/v1/get_permits/?contractor_ref_id=7465a9b2af6e4bfdb2015d288fbe8390-CTX00352916

Query Param Value
contractor_ref_id 7465a9b2af6e4bfdb2015d288fbe8390-CTX00352916
Response Body with status code
200
    {
    "permit_details": [

        {
            "property_address": "1525 ARKANSAS LN GRAND PRAIRIE TX 75052",
            "property_id": "P4811300298272",
            "permit_number": "09-00004520",
            "permit_status": "AP",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2009-09-16",
            "permit_status_date": "2009-10-12",
            "permit_expiry_date": null,
            "permit_issued_date": "2009-10-26",
            "permit_fees": null,
            "valuation": 320727,
            "pin": null,
            "parcel_id": "28-02375-002-001-0000",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3025023,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": null,
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": null,
            "applicant_details": null
        },

        {
            "property_address": "2975 ESPLANADE GRAND PRAIRIE TX 75052",
            "property_id": "P4811300286529",
            "permit_number": "09-00003586",
            "permit_status": "CL",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2009-07-22",
            "permit_status_date": "2015-01-21",
            "permit_expiry_date": null,
            "permit_issued_date": "2009-08-28",
            "permit_fees": null,
            "valuation": 231500,
            "pin": null,
            "parcel_id": "28-02375-002-003-0000",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3026098,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": "8600 ROYAL LN GRAND PRAIRIE, TX 75063",
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": null,
            "applicant_details": null
        },

        {
            "property_address": "1600 LONE STAR PKWY GRAND PRAIRIE TX 75050",
            "property_id": "P4811300298282",
            "permit_number": "08-00001628",
            "permit_status": "AP",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2008-03-12",
            "permit_status_date": "2008-03-27",
            "permit_expiry_date": null,
            "permit_issued_date": "2008-03-27",
            "permit_fees": null,
            "valuation": 5000,
            "pin": null,
            "parcel_id": "65-11840-051-001-2000",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3026167,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": "8600 ROYAL LN GRAND PRAIRIE, TX 75063",
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": [{
                "owner_name": "GRAND PRAIRIE SPORTS",
                "owner_address": null,
                "owner_organization": null,
                "owner_contact_number": null
            }],
            "applicant_details": null
        },

        {
            "property_address": "1600 LONE STAR PKWY GRAND PRAIRIE TX 75050",
            "property_id": "P4811300298282",
            "permit_number": "08-00000247",
            "permit_status": "AP",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2008-01-15",
            "permit_status_date": "2008-01-30",
            "permit_expiry_date": null,
            "permit_issued_date": "2008-01-30",
            "permit_fees": null,
            "valuation": 115239,
            "pin": null,
            "parcel_id": "65-11840-051-001-2000",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3026168,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": "8600 ROYAL LN GRAND PRAIRIE, TX 75063",
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": [{
                "owner_name": "GRAND PRAIRIE SPORTS",
                "owner_address": null,
                "owner_organization": null,
                "owner_contact_number": null
            }],
            "applicant_details": null
        },

        {
            "property_address": "2030 PROCTOR DR GRAND PRAIRIE TX 75051",
            "property_id": "P4811300298423",
            "permit_number": "09-00002245",
            "permit_status": "CL",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2009-05-12",
            "permit_status_date": "2015-01-21",
            "permit_expiry_date": null,
            "permit_issued_date": "2009-05-14",
            "permit_fees": null,
            "valuation": 18633,
            "pin": null,
            "parcel_id": "28-14575-001-001-0000",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3026480,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": "8600 ROYAL LN GRAND PRAIRIE, TX 75063",
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": [{
                "owner_name": "GRAND PRAIRIE I S D",
                "owner_address": null,
                "owner_organization": null,
                "owner_contact_number": null
            }],
            "applicant_details": null
        },

        {
            "property_address": "501 FOUNTAIN PKWY GRAND PRAIRIE TX 75050",
            "property_id": "P4811300299238",
            "permit_number": "09-00003811",
            "permit_status": "AP",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2009-08-05",
            "permit_status_date": "2009-08-11",
            "permit_expiry_date": null,
            "permit_issued_date": "2009-08-11",
            "permit_fees": null,
            "valuation": 106788,
            "pin": null,
            "parcel_id": "81-2035-1R-2-",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3026755,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": "8600 ROYAL LN ALPHARETTA, GA 75063",
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": [{
                "owner_name": "SIEMENS ENERGY & AUTOMATION",
                "owner_address": null,
                "owner_organization": null,
                "owner_contact_number": null
            }],
            "applicant_details": null
        },

        {
            "property_address": "102 GOPHER BLVD GRAND PRAIRIE TX 75050",
            "property_id": "P4811300298034",
            "permit_number": "08-00004644",
            "permit_status": "CL",
            "permit_category": "Fire Protection Permit",
            "permit_type": "Fire Alarm",
            "permit_sub_type": null,
            "permit_class": "Commercial",
            "work_description": null,
            "permit_applied_date": "2008-07-24",
            "permit_status_date": "2008-12-16",
            "permit_expiry_date": null,
            "permit_issued_date": "2008-07-29",
            "permit_fees": null,
            "valuation": 10184,
            "pin": null,
            "parcel_id": "28-16600-001-001-0000",
            "master_permit_number": null,
            "units": null,
            "stories": null,
            "total_sqft": "0",
            "comments": "FIRE ALARM PERMITS",
            "permit_issued_office": null,
            "permit_id": 3028925,
            "contractor_details": [{
                "contractor_name": null,
                "contractor_organization": "SIEMENS",
                "contractor_phone": "(972) 550-8488",
                "contractor_address": null,
                "contractor_license_type": null,
                "contractor_license_number": null
            }],
            "owner_details": null,
            "applicant_details": null
        }

    ],
    "total_valuation": 808071.0,
    "permits_count": 7
    }

Scenario 2 - Contractor Not Found

/POST

https://permits.himaintenance.io/contractor-api/v1/initiate-search

Body
{ "contractor_organization": "davidbeckham" }
Response Body with status code
200
{
    "reference_id": "f3bbc3c598b549a8907bc7b58ddfb791",
    "contractor_organization": "davidbeckham",
    "status": "IN_PROGRESS"
}

/GET

https://permits.himaintenance.io/contractor-api/v1/get-status/?reference_id=f3bbc3c598b549a8907bc7b58ddfb791

Query Param Value
reference_id f3bbc3c598b549a8907bc7b58ddfb791
Response Body with status code
200
{
    "searched_organization": "davidbeckham",
    "status": "CONTRACTOR_NOT_FOUND",
    "search_result": []
}

Scenario 3 - Invalid Inputs

/GET

https://permits.himaintenance.io/contractor-api/v1/get-status/?reference_id=invalidreferenceid123

Query Param Value
reference_id invalidreferenceid123
Response Body with status code
400
{
    "status_message": "No record found with the given reference_id."
}

/GET

https://permits.himaintenance.io/contractor-api/v1/get_contractor_data/?contractor_ref_id=invalidcontractorrefid123

Query Param Value
contractor_ref_id invalidcontractorrefid123
Response Body with status code
400
{
    "contractor_id": "7465a9b2ajjkf6e4bfdb2015d288fbe8390-CTX00352916",
    "status": "Check inputs, extraction failed.",
    "status_code": 400,
    "message": "Invalid input. We tried if you have given the reference_id but, no record found with the given reference ID."
}

/GET

https://permits.himaintenance.io/contractor-api/v1/get_permits/?contractor_ref_id=invalidcontractorrefid123

Query Param Value
contractor_ref_id invalidcontractorrefid123
Response Body with status code
400
{
    "contractor_id": "7465a9b2af6e4hbfdb2015d288fbe8390-CTX00352916",
    "status": "Check inputs, extraction failed.",
    "status_code": 400,
    "message": "Invalid input. We tried if you have given the reference_id but, no record found with the given reference ID."
}



Audit Service

/GET

Using Tenant ID
http://permits.himaintenance.io/audit-svc/tenanttransactionscount?tenant_id=tenant4

/GET

Using User ID
http://permits.himaintenance.io/audit-svc/usertransactionscount?user_id=user1

/GET

Using Status
http://permits.himaintenance.io/audit-svc/statustransactionscount?status=SUCCESS

/GET

Using Date Range
http://permits.himaintenance.io/audit-svc/transactionscountbyrequesttime?fromDate=2021-05-04&toDate=2021-05-05
Following are unique parameters that can be used
Query Param Value
tenant_id tenant4
user_id user1
status SUCCESS
fromDate 2021-05-04
toDate 2021-05-05
Response Body with status code
200
{"count":28}

/GET

Verifying the service is up
https://permits.himaintenance.io/search-svc/ping
"success"
©2021 by MessyData Inc. All Rights Reserved.