EN
Español
English
Português
    Company Search by Name

    You get a list of companies that match a name or part of a company name.

    Petition Details

    • Base URL: {host}/ASMSAPI/
    • Uri: /api/v9/company/getbyname?companyName={companyName}&projectId={projectId}&matchName={matchName}
    • Type: GET

    • Required headings:

    • content-type: application/json
    • X-Authorization: Bearer {token}

    URL Description

    • {host}: It represents the domain of the environment in which the API is located.
    • ASMSAPI/: Fixed API prefix.
    • URI: Specific endpoint for the request.


    ⚐ EXAMPLE URL:

    https://{host}/ASMSAPI/api/v9/company/getbyname?companyName={companyName}&projectId={projectId}&matchName={matchName}


    Parameters

    Name Data type Obligatory Description
    companyName Text Yes Full or partial name of the companies you want to find
    projectId Number No Project ID
    matchName Boolean No Determine if the search should be accurate

    Body of the petition

    N/A

    Examples of uri

    • api/v9/company/getbyname?companyName=Guia&projectId=25&matchName=true

    Answer

    Sample Answer

    {
    "description": "Aranda software",
    "Id": 2,
    "isActive": true,	
    "location": "",
    "name": "Aranda Software",
    "nit": "1",
    "stateId": 1
}

    Response parameters

    Title Data type Description
    Description Text Company Description
    Id Number Company ID
    isActive Boolean Determine if the company is active
    Location Text Company Location
    Name Text Company Name
    Nit Text Company NIT
    stateId Number State ID

    Error messages

    Code HTTP status Error Message
    400 BacRequest IdNotEmpty
    500 InternalServerError FailureGetCompanyByName