/
Suspensión/Aprobación/Cancelación/Finalización/Copiado de Pautas

Suspensión/Aprobación/Cancelación/Finalización/Copiado de Pautas

Mar 07, 2018

Suspensión de pauta

Suspende una pauta que está activa

URL: /admin/jsapi/pauta?op=sus

 

Requisitos:

             La pauta debe estar activa

             Se debe conocer su identificador (pauta_id)

 

Parámetros obligatorios:

Se debe incluir el parámetro pauta_id, con el identificador de la pauta.  

 

Ejemplo de request:

            URL: /admin/jsapi/pauta?op=sus

Parámetros:

            pauta_id=43242

Explicación de los parámetros:

            pauta_id: identificador de la pauta

 

Respuesta:

Contiene un objeto pauta_id , indicando el id de la pauta suspendida y un objeto status, que indica el estado del resultado, en este caso 200, indica que la pauta se suspendió correctamente.

Si la operación es fallida, mediante el objeto errors, muestra un listado de errores, indicando:

- un atributo que indica cada campo erróneo.

- y el valor de cada uno de esos atributos indicando  mensaje de error correspondiente.

También contiene un objeto status, que indica que el resultado fue erróneo.

 

Ejemplo de respuesta sin errores

{'pauta_id':'4496088','status':200}

 

Ejemplo de respuesta con errores

{'status':403}


 

 

Aprobación de pauta

Aprueba una pauta para que comience a ejecutarse.

            URL: /admin/jsapi/pauta?op=apr

 

Requisitos:

            La pauta debe estar en estado Inicial o Programada

            Se debe conocer su identificador (pauta_id)

            El usuario debe tener el permiso de aprobación de pautas

 

Parámetros obligatorios:

            Se debe incluir el parámetro pauta_id, con el identificador de la pauta.  

 

Ejemplo de request:

            URL: /admin/jsapi/pauta?op=apr

Parámetros:

            pauta_id=43242

Explicación de los parámetros:

            pauta_id: identificador de la pauta

 

Respuesta:

Contiene un objeto pauta_id , indicando el id de la pauta aprobada y un objeto status, que indica el estado del resultado, en este caso 200, indica que la pauta se aprobó correctamente.

Si la operación es fallida, mediante el objeto errors, muestra un listado de errores, indicando:

- un atributo que indica cada campo erróneo.

- y el valor de cada uno de esos atributos indicando  mensaje de error correspondiente.

También contiene un objeto status, que indica que el resultado fue erróneo.

 

Ejemplo de respuesta sin errores

{'pauta_id':'4496088','status':200}

 

Ejemplo de respuesta con errores

{'status':403}

 


Cancelación de pauta

Cancela una pauta creada – la misma deja de correr.

            URL: /admin/jsapi/pauta?op=b

 

Requisitos:

            Se debe conocer el identificador (pauta_id)

            El usuario debe tener el permiso de borrado de pautas 

 

Parámetros obligatorios:

            Se debe incluir el parámetro pauta_id, con el identificador de la pauta.  

 

Ejemplo de request:

            URL: /admin/jsapi?op=b

Parámetros:

            pauta_id=43242

 

Explicación de los parámetros:

            pauta_id: identificador de la pauta

 

Respuesta:

Contiene un objeto pauta_id , indicando el id de la pauta cancelada y un objeto status, que indica el estado del resultado, en este caso 200, indica que la pauta se cancelo correctamente.

Si la operación es fallida, mediante el objeto errors, muestra un listado de errores, indicando:

- un atributo que indica cada campo erróneo.

- y el valor de cada uno de esos atributos indicando  mensaje de error correspondiente.

También contiene un objeto status, que indica que el resultado fue erróneo.

 

Ejemplo de respuesta sin errores

{'pauta_id':'4496088','status':200}

 

Ejemplo de respuesta con errores

{'status':403}

 

 

Finalización de pauta

Pasa una pauta al estado Completada – la pauta deja de correr

            URL: /admin/jsapi?op=completar

 

Requisitos:

            La pauta debe estar en estado Activa o Activa/Fuera de horario

            Se debe conocer el identificador (pauta_id)

            El usuario debe tener el permiso de completar/finalizar pautas 

 

Parámetros obligatorios:

            Se debe incluir el parámetro pauta_id, con el identificador de la pauta.  

 

Ejemplo de request:

            URL: /admin/jsapi/pauta?op=completar

Parámetros:

            pauta_id=43242

Explicación de los parámetros:

            pauta_id: identificador de la pauta

 

Respuesta:

Contiene un objeto pauta_id , indicando el id de la pauta finalizada y un objeto status, que indica el estado del resultado, en este caso 200, indica que la pauta se finalizo correctamente.

Si la operación es fallida, mediante el objeto errors, muestra un listado de errores, indicando:

- un atributo que indica cada campo erróneo.

- y el valor de cada uno de esos atributos indicando  mensaje de error correspondiente.

También contiene un objeto status, que indica que el resultado fue erróneo, con un valor de 403.

 

Ejemplo de respuesta sin errores

{'pauta_id':'4496088','status':200}

 

Ejemplo de respuesta con errores

{'status':403}

 

Reactivación de pauta

Pasa una pauta del estado Completada a Activa, siempre y cuando la misma haya sido completada dentro de los últimos 30 días.

            URL: /admin/jsapi?op=ap

 

Requisitos:

            La pauta debe estar en estado Completada

            Se debe conocer el identificador (pauta_id)

            El usuario debe tener el permiso de reactivar pautas 

 

Parámetros obligatorios:

            Se debe incluir el parámetro pauta_id, con el identificador de la pauta.  

 

Ejemplo de request:

            URL: /admin/jsapi/pauta?op=ap

Parámetros:

            pauta_id=43242

 

Explicación de los parámetros:

            pauta_id: identificador de la pauta

 

Respuesta:

Contiene un objeto pauta_id , indicando el id de la pauta reactivada y un objeto status, que indica el estado del resultado, en este caso 200, indica que la pauta se reactivo correctamente.

Si la operación es fallida, mediante el objeto errors, muestra un listado de errores, indicando:

- un atributo que indica cada campo erróneo.

- y el valor de cada uno de esos atributos indicando  mensaje de error correspondiente.

También contiene un objeto status, que indica que el resultado fue erróneo, con un valor de 403.

 

Ejemplo de respuesta sin errores

{'pauta_id':'4496088','status':200}

Ejemplo de respuesta con errores

{'status':403}

 

Copiado de pautas

Genera una copia de una pauta existente en el sistema.

URL:/admin/jsapi/pauta?op=copy

Parámetro obligatorios:

  • pauta_id: identificador de la pauta que se desea copiar.

  • nombre: nombre de la nueva pauta.

  • opcion_fecha_fin: se debe indicar cómo se quiere setear la duración de la pauta. Estas son las opciones: 5* >> Fecha de inicio y Fecha de fin / 2 >> Misma duración / 1 >> Misma fecha de fin

*Si se selecciona 5 se deben agregar los siguientes parámetros:

fecha_fin   
fecha_inicio   
hora_fin   
hora_inicio

Parámetros posibles:

  • ptestado_id:  estado de la pauta.  Si no se especifica, muestra pautas de todos los estados. Ver valores posibles en  Referencias -  Estados de pautas.

  • anunciante_id: identificador del anunciante.  Si no se especifica, muestra pautas de todos los anunciantes.

  • mes_ano: para mostrar sólo las pautas de un período determinado.  Se indica mes y año con el siguiente formato: MM/AAAA.  Ejemplo: 03/2006. 

Ejemplos de URLs con parámetros:

/admin/admin/jsapi/pauta?op=copy&pauta_id=3903&nombre=TESTAPI1&opcion_fecha_fin=1&o=xml

/admin/admin/jsapi/pauta?op=copy&pauta_id=3903&nombre=TESTAPI2&opcion_fecha_fin=2&o=xml

/admin/admin/jsapi/pauta?op=copy&pauta_id=3903&nombre=TESTAPI3&opcion_fecha_fin=5&fecha_fin=18/04/2015&fecha_inicio=01/04/2015&hora_fin=10:00:00&hora_inicio=10:00:00:&o=xml

 

Respuesta:

Contiene un objeto <operacion> que a su vez contiene un tag <resultado>.  El valor de resultado puede ser 1 (operación exitosa) o 0 (operación fallida).

Si la operación es fallida, se agrega además un listado de errores, mediante tags <error>, que contienen el atributo atributo, que especifica el nombre del atributo con error, y mensaje, con el mensaje de error.

 

Ejemplo de respuesta sin errores

{'pauta_id':'3907','status':200}

 

Ejemplo de respuesta con errores

{'status':403}

 

Ejemplo en PHP:

        $username       = 'usuario@dominio';
        $password        = 'reemplazar_por_pass';

    $urlCopy     = 'https://admin.us.e-planning.net/admin/jsapi/pauta?op=copy'; //Copiar la pauta
    $postData   .= '&nombre='.urlencode($arrReturn['pauta']['nombre'].' - migrada');
    $postData   .= '&opcion_fecha_fin=5&fecha_inicio='.urlencode('04/03/2016').'&hora_inicio='.urlencode('08:00:00').'&fecha_fin='.urlencode('04/03/2017').'&hora_fin='.urlencode('08:00:00');
    $postData   .= '&status_aceptar=0&status_cancelar_top=0&confirmar=0&planificar_inventario=0&planificacion_resultado=3&planificacion_token=';
    $postData   .= '&aceptar_bottom=Aceptar&status_cancelar_top=0';

    $processCopy = curl_init($urlCopy);
    curl_setopt($processCopy, CURLOPT_HEADER, 1);
    curl_setopt($processCopy, CURLOPT_USERPWD, $username . ':' . $password);
    curl_setopt($processCopy, CURLOPT_TIMEOUT, 30);
    curl_setopt($processCopy, CURLOPT_POST, 1);
    curl_setopt($processCopy, CURLOPT_POSTFIELDS, $postData);
    curl_setopt($processCopy, CURLOPT_RETURNTRANSFER, TRUE);
    $returnCopy = curl_exec($processCopy);


Referencias:

Donde $arrReturn['pauta']['nombre'] corresponde al nombre de una pauta que se recorre de un array previo.
Los valores de los parametros deben ser pasados encodeados (urlencode).