ES
Español
English
Português
    Búsqueda de compañías

    Obtiene un listado de compañías o proveedores que coincidan con criterios de búsqueda.

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/company/search?itemType={itemType}&projectId={projectId}&clientId={clientId}&serviceId={serviceId}&criteria={criteria}&filterCaseUser={filterCaseUser}
    • Tipo: GET
    • Encabezados requeridos:

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

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.


    EJEMPLO URL:

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


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    itemType Enumerador Tipo de búsqueda (Compañia = 38, Proveedor = 52)
    projectId Número No Identificador del proyecto
    clientId Número No Identificador del cliente
    serviceId Número No Identificador del servicio
    criteria Texto No Texto de búsqueda de usuario
    filterCaseUser Texto No Determina si se debe hacer filtro previo por cliente

    Cuerpo de la petición

    N/A

    Ejemplos de uri

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

    Respuesta

    {
        "content": [
            {
                "id": 1,
                "locationId": 2,
                "name": "Guia"
            }
        ],
        "totalItems": 1
    }
    

    Parámetros de Respuesta

    Título Tipo de dato Descripción
    Id Número Id de la compañía
    location Texto Ubicación de la compañía
    name Texto Nombre de la compañía

    Mensajes de Error

    Código Estado HTTP Mensaje de error
    403 Forbidden AccessDenied
    500 InternalServerError FailureGetDetail