EN
Español
English
Português
    Company Search

    You get a list of companies or suppliers that match your search criteria.

    Petition Details

    • Base URL: {host}/ASMSAPI/
    • Uri: /api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}
    • 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.


    ⚐ EJEMPLO URL:

    https://{host}/ASMSAPI/api/api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}


    Parameters

    Name Data type Obligatory Description
    itemType Enumerator Yes Search type (Compañia = 38, Proveedor = 58)
    projectId Number No Project ID
    clientId Number No Customer ID
    serviceId Number No Service Identifier
    Criteria Text No User Search Text
    filterCaseUser Text No Determine if you should pre-filter per customer

    Body of the petition

    N/A

    Examples of uri

    • api/v9/company/search?itemType=38&projectId=2&criteria=Guia
    • api/v9/company/search?itemType=58&projectId=2
    • api/v9/company/search?itemType=38&projectId=2&criteria=

    Answer

    {
    "content": [
        {
            "hasIntegration": false,
            "id": 1,
            "locationId": 2,
            "name": "Guia",
            "projectId": 25
        }
    ],
    "totalItems": 1
}

    Response Parameters

    Name Data type Description
    Address1 Text First Address Field
    Address2 Text Second Address Field
    Address3 Text Third Address Field
    CityId Number City Identifier
    CityName Text Descriptive name of the city
    Contact Text Main contact of the company
    CountryId Number Identifier of the country where the company is located
    CountryName Text Friendly name of the country where the company is located
    Description Text Corrective actions when the case is marked as a major problem
    Email Text Email of the company’s main contact
    Ext Text Telephone extension of the company’s main contact
    FaxNumber Text Fax number of the company’s main contact
    Id Number Company Identifier
    isActive Boolean True if the company is active
    Location Text Location
    Mobil Text Mobile phone number of the company’s main contact
    Name Text Friendly name of the company
    Nit Text Company Tax Identification Number (NIT)
    Phone1 Text The company’s first phone
    Phone2 Text Second phone of the company
    Phone3 Text Third phone of the company
    StatusId Number State ID
    WebSiteURL Text Company website URL
    ProjectId Number Project ID
    ConsoleType Number Identifier of the console originating the request
    RegisterType Number Type of record to create (Compañia = 38, Proveedor = 58)

    Error Messages

    Code HTTP status Error Message
    400 BadRequest IdNotEmpty
    500 InternalServerError FailureGetDetail