Home
Adobe PDF

Descargar PDF
    Creación compañía

    Esta operación crea una compañía. Al crearlo, guarda los archivos adjuntos tanto del caso como de sus campos adicionales. Luego de guardarlos, los borra de la carpeta temporal creada para ello.

    Detalles de la petición

    • Uri: /api/v9/company
    • Tipo: POST
    • Encabezados requeridos:
      • content-type: application/json
      • X-Authorization: Bearer {token}

    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    Address1 Texto No Primer campo de dirección
    Address2 Texto No Segundo campo de dirección
    Address3 Texto No Tercer campo de dirección
    CityId Número No Identificador de la ciudad
    CityName Texto No Nombre descriptivo de la ciudad en la que está ubicada la compañía
    Contact Texto No Principal contacto de la compañía
    CountryId Número No Identificador del país donde está ubicada la compañía
    CountryName Texto Sí Nombre descriptivo del país donde está ubicada la compañía
    Description Texto No Acciones correctivas cuando el caso está marcado como problema mayor
    Email Texto No Correo electrónico del principal contacto de la compañía
    Ext Texto No Extensión telefónica del principal contacto de la compañía
    FaxNumber Texto No Número de fax del principal contacto de la compañía
    Id Número No Identificador de la compañía
    isActive Boolean No Verdadero si la compañía está activa
    Location Texto No Ubicación
    Mobil Texto No Número de teléfono móvil del principal contacto de la compañía
    Name Texto Sí Nombre descriptivo de la compañía
    Nit Texto Sí NIT (Número de identificación tributaria) de la compañía
    Phone1 Texto No Primer teléfono de la compañía
    Phone2 Texto Sí Segundo teléfono de la compañía
    Phone3 Texto No Tercer teléfono de la compañía
    StatusId Número Sí Identificador del estado
    WebSiteURL Texto No URL del sitio web de la compañía
    ProjectId Número Sí Identificador del proyecto
    ConsoleType Número Sí Identificador de la consola de origen de la petición. Solo se permite la creación desde la consola de administración (Valor 3)
    RegisterType Número Sí Tipo de registro a crear: Compañía = 38, Proveedor = 58

    Campos adicionales (ListAdditionalField)

    Nombre Tipo de dato Obligatorio Descripción
    boolValue Boolean No Valor booleano del campo adicional
    description Texto No Descripción del campo adicional
    enable Boolean Sí Determina si el campo adicional está activo
    order Número No Orden a tener en cuenta en el listado de campos adicionales
    dateValue Fecha No Valor fecha del campo adicional
    fieldId Número Sí Identificador del campo adicional
    fieldType Número Sí Tipo del campo adicional
    floatValue Número No Valor decimal del campo adicional
    identifier Texto No Identificador del campo adicional
    itemId Stream No Valor en bytes del archivo para el campo adicional
    intValue Número No Valor en número para el campo adicional
    stringValue Texto No Valor en texto del campo adicional
    mandatory Booleano Sí Si el campo adicional es obligatorio o no
    name Texto Sí Nombre identificativo del campo
    visible Booleano Sí El campo adicional debe ser visible o no en los formularios
    type Número No Tipo de objeto que representa al objeto padre

    Cuerpo de la petición

    {
    "Address1": "",
    "Address2": "",
    "Address3": "",
    "CityId": 4,
    "CityName": "Cali",
    "Contact": "Servicio al cliente",
    "CountryId": 2,
    "CountryName": "Colombia",
    "Description": "Empresa Guia",
    "Email": "correo@empresaguia.com",
    "Ext": "",
    "FaxNumber": "",
    "Id": "",
    "isActive": true,
    "Location": "",
    "Mobil": "3111111111",
    "Name": "Guia",
    "Nit": "80090000909",
    "Phone1": "6022002020",
    "Phone2": "6023003030",
    "Phone3": "",
    "StatusId": "1",
    "WebSiteURL": "",
    "ProjectId": "25",
    "ConsoleType": 3,
    "RegisterType": 38,
    "listAdditionalField": [
        {
            "boolValue": null,
            "catalogId": null,
            "dateValue": null,
            "fieldId": 977,
            "fieldType": 3,
            "floatValue": null,
            "identifier": "A001",
            "inputStream": null,
            "intValue": 118,
            "stringValue": "Aranda Data Safe",
            "mandatory": true
        },
        {
            "boolValue": null,
            "catalogId": null,
            "dateValue": null,
            "fieldId": 978,
            "fieldType": 3,
            "floatValue": null,
            "inputStream": null,
            "intValue": 146,
            "mandatory": true,
            "stringValue": "Aranda Virtual Support"
        }
    ]
}

    Respuesta

    {
    "id": 1
}

    Parámetros de Respuesta

    Nombre Tipo de dato Descripción
    id Número Identificador de la compañía

    Mensajes de Error

    Código Estado HTTP Mensaje de error
    400 BadRequest \r\nNombre del parámetro: ConsoleType
    400 BadRequest \r\nNombre del parámetro: Name
    400 BadRequest \r\nNombre del parámetro: RegisterType
    400 BadRequest InvalidProjectId
    400 BadRequest StateIdIsEmpty
    400 BadRequest InvalidRegisterType
    400 BadRequest InvalidConsole
    403 Forbidden DoNotHavePermissionForThisAction
    500 InternalServerError FailureAddCompany