ES
Español
English
Português
    Manejo de Compañías

    En esta sección se describen las operaciones relacionadas con el manejo de compañías (creación, edición).

    Agregar una Compañía

    Detalles de la petición

    • URI: api/v8.6/company/add/{projectId}/type/{type}

    • Tipo: POST

    • Encabezados requeridos:

      • content-type: application/json
      • Authorization: TOKEN

    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    projectId Número Si Id del proyecto en el que se creará la compañía.
    type Número Si 1 = Compañía, 2 = Proveedor
    ALIAS Texto Si Alias de la compañía.
    LATITUDE Numero No Latitud ubicación compañía.
    LONGITUDE Numero No Longitud ubicación compañía
    GOOGLEADDRES Texto No Dirección guardada en el mapa
    (geolocalización)      
    NIT Texto Si Identificador de la compañía.
    WEBSITE Texto No Sitio web
    EMAIL Texto No Correo electrónico
    DESCRIPTION Texto No Descripción de la compañía.
    CONTACT Texto No Nombre del contacto.
    COMPANYNAME Texto Si Nombre de la compañía.
    COUNTRYID Número No id del país.
    CITYID Número No id de la ciudad.
    ADDRESS Texto No Dirección 1.
    ADDRESS2 Texto No Dirección 2.
    ADDRESS3 Texto No Dirección 3.
    ADDITIONALFIELD1 Texto No Campo adicional.
    ADDITIONALFIELD2 Texto No Campo adicional.
    ADDITIONALFIELD3 Texto No Campo adicional.
    ADDITIONALFIELD4 Texto No Campo adicional.
    ADDITIONALFIELD5 Texto No Campo adicional.
    ADDITIONALFIELD6 Texto No Campo adicional.
    ADDITIONALFIELD7 Texto No Campo adicional.
    ADDITIONALFIELD8 Texto No Campo adicional.
    ADDITIONALFIELD9 Texto No Campo adicional.
    ADDITIONALFIELD10 Texto No Campo adicional.
    STATEID Número No id de estado. Se debe poner el valor 1..

    Cuerpo de la petición

    En Field se pueden utilizar los parámetros descritos anteriormente, excepto los de la URI (projectId, type). Los valores mínimos para la creación son los siguientes.

    [
    {
        "Field": "ALIAS",
        "Value": "Aranda test"
    },
    {
        "Field": "NIT",
        "Value": "9052646"
    },
    {
        "Field": "COMPANYNAME",
        "Value": "Aranda test"
    },
    {
        "Field": "STATEID",
        "Value": "1"
    }
]

    Respuesta

    El servicio retornara un entero el cual es el id de la compañía creada, ejemplo: 10091

    Mensajes de error

    Código Estado HTTP Mensaje de error
    400 BadRequest InvalidProjectId
    400 BadRequest InvalidType
    400 BadRequest InvalidCompany
    400 BadRequest InvalidCompanyAlias
    400 BadRequest InvalidCompanyId


    Editar una Compañía

    Detalles de la petición

    • URI: api/v8.6/company/update/{projectId}/{id}

    • Tipo: POST

    • Encabezados requeridos:

      • content-type: application/json
      • Authorization: TOKEN

    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    projectId Número Si Id del proyecto al que pertenece la compañía.
    id Número Si Id de la compañía
    LATITUDE Numero No Latitud ubicación compañía.
    LONGITUDE Numero No Longitud ubicación compañía
    GOOGLEADDRES Texto No  
    NIT Texto Si Identificador de la compañía.
    WEBSITE Texto No Sitio web
    EMAIL Texto No Correo electrónico
    DESCRIPTION Texto No Descripción de la compañía.
    CONTACT Texto No Nombre del contacto.
    COMPANYNAME Texto Si Nombre de la compañía.
    COUNTRYID Número No id del país.
    CITYID Número No id de la ciudad.
    ADDRESS Texto No Dirección 1.
    ADDRESS2 Texto No Dirección 2.
    ADDRESS3 Texto No Dirección 3.
    ADDITIONALFIELD1 Texto No Campo adicional.
    ADDITIONALFIELD2 Texto No Campo adicional.
    ADDITIONALFIELD3 Texto No Campo adicional.
    ADDITIONALFIELD4 Texto No Campo adicional.
    ADDITIONALFIELD5 Texto No Campo adicional.
    ADDITIONALFIELD6 Texto No Campo adicional.
    ADDITIONALFIELD7 Texto No Campo adicional.
    ADDITIONALFIELD8 Texto No Campo adicional.
    ADDITIONALFIELD9 Texto No Campo adicional.
    ADDITIONALFIELD10 Texto No Campo adicional.
    STATEID Número No id de estado. Se debe poner el valor 1..

    Cuerpo de la petición

    En Field se pueden utilizar los parámetros descritos anteriormente, excepto los de la URI (projectId, id).

    [
    {
    "Field": "COMPANYNAME",
    "Value": "Aranda edit"
    }
   ]

    Respuesta

    El servicio retornará un booleano indicando si la operación se ha podido hacer. Ejemplo: true indica que la edición fue exitosa.

    Mensajes de error

    Código Estado HTTP Mensaje de error
    400 BadRequest InvalidProjectId
    400 BadRequest InvalidCompanyId
    500 InternalServerError FailureUpdateCompany