Recaudación de fondos de Blackbaud Raisers Edge LIST
Blackbaud Raiser's Edge EDITION es una completa solución de software de recaudación de fondos y administración de donantes basada en la nube creada específicamente para organizaciones sin ánimo de lucro y toda la comunidad de buena comunidad social. Use el conector de recaudación de fondos para administrar campañas, fondos, apelaciones y paquetes.
Este conector está disponible en los siguientes productos y regiones:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Aplicaciones lógicas | Estándar | Todas las regiones de Logic Apps excepto las siguientes: - Regiones de Azure Government - Regiones de Azure China - Departamento de Defensa de EE. UU. (DoD) |
| Power Apps | Premium | Todas las regiones de Power Apps excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Power Automate | Premium | Todas las regiones de Power Automate excepto las siguientes: - Gobierno de EE. UU. (GCC) - Gobierno de EE. UU. (GCC High) - China Cloud operado por 21Vianet - Departamento de Defensa de EE. UU. (DoD) |
| Contacto | |
|---|---|
| Nombre | Compatibilidad con Blackbaud |
| URL | https://www.blackbaud.com/support |
| Correo Electrónico | skyapi@blackbaud.com |
| Metadatos del conector | |
|---|---|
| Publicador | Blackbaud, Inc. |
| Sitio web | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| Directiva de privacidad | https://www.blackbaud.com/privacy-shield |
| Categorías | Ventas y CRM; Productividad |
Raiser's Edge EDITION es una solución completa de software de gestión de donantes y recaudación de fondos basada en la nube creada específicamente para organizaciones sin ánimo de lucro y toda la comunidad social.
Este conector se basa en la API SKY de Blackbaud y proporciona operaciones para ayudar a administrar las entidades de recaudación de fondos que se encuentran en The Raiser's Edge STORAGE, entre las que se incluyen:
- Campañas
- Fondos
- Apelaciones
- Packages
- Y mucho más...
Para obtener más información, consulte la documentación.
Prerrequisitos
Para usar este conector, debe tener una cuenta de identificador de Blackbaud con acceso a uno o varios entornos de Blackbaud.
Además, el administrador de la organización también debe realizar una acción de nivel de administrador dentro del sistema para permitir que este conector acceda al entorno de Blackbaud. Puede encontrar más información sobre estos requisitos previos en la documentación de configuración inicial .
¿Cómo obtener credenciales?
El administrador de la organización le enviará una invitación al entorno edge DE RAISER de raiser y configurará los permisos de la cuenta de usuario dentro del entorno. No se requieren credenciales adicionales para usar este conector.
Problemas y limitaciones conocidos
El conector funcionará en el contexto de la cuenta de usuario y, por tanto, estará sujeto a los permisos de usuario dentro del entorno.
Limitaciones
| Nombre | Llamadas | Período de renovación |
|---|---|---|
| Llamadas API por conexión | 100 | 60 segundos |
Acciones
| Actualización de datos adjuntos de apelación |
Actualiza los datos adjuntos de una apelación. |
| Actualización de un campo personalizado de apelación |
Actualiza un campo personalizado de apelación. |
| Actualización de una apelación |
Actualiza una apelación. |
| Actualización de una apelación constituyente |
Actualiza una apelación constituyente. |
| Actualizar datos adjuntos de un fondo |
Actualiza un fondo adjunto. |
| Actualizar datos adjuntos de una campaña |
Actualiza los datos adjuntos de una campaña. |
| Actualizar un campo personalizado de campaña |
Actualiza un campo personalizado de campaña. |
| Actualizar un campo personalizado de fondo |
Actualiza un campo personalizado de fondo. |
| Actualizar un fondo |
Actualiza un fondo. |
| Actualizar una campaña |
Actualiza una campaña. |
| Creación de datos adjuntos de apelación |
Crea un nuevo archivo adjunto de apelación. |
| Creación de un campo personalizado de apelación |
Crea un nuevo campo personalizado de atractivo. |
| Creación de un campo personalizado de fondo |
Crea un nuevo campo personalizado de fondo. |
| Creación de un recurso constituyente |
Crea un nuevo recurso constituyente. |
| Creación de una apelación |
Crea una nueva apelación. |
| Crear datos adjuntos de campaña |
Crea datos adjuntos de campaña. |
| Crear un campo personalizado de campaña |
Crea un nuevo campo personalizado de campaña. |
| Crear un fondo |
Crea un nuevo fondo. |
| Crear un fondo adjunto |
Crea un nuevo fondo adjunto. |
| Crear una campaña |
Crea una nueva campaña. |
| Enumerar campañas |
Devuelve una lista de campañas. |
| Enumerar campos personalizados de atractivo |
Enumera los campos personalizados de una apelación. |
| Enumerar campos personalizados de campaña |
Enumera los campos personalizados de una campaña. |
| Enumerar campos personalizados del fondo |
Enumera los campos personalizados de un fondo. |
| Enumerar datos adjuntos de campaña |
Enumera los datos adjuntos de una campaña. |
| Enumerar datos adjuntos de fondos |
Enumera los datos adjuntos de un fondo. |
| Enumerar fondos |
Devuelve una lista de fondos. |
| Enumerar las apelaciones |
Devuelve una lista de apelaciones. |
| Enumerar las apelaciones constituyentes |
Enumera los llamamientos para un constituyente. |
| Enumerar las relaciones constituyentes del fondo |
Enumera las relaciones constituyentes de un fondo. |
| Enumerar las relaciones de los fondos constituyentes |
Enumera las relaciones de fondo para un constituyente. |
| Enumerar los datos adjuntos de la apelación |
Enumera los datos adjuntos de una apelación. |
| Enumerar paquetes |
Devuelve una lista de paquetes. |
| Obtener un fondo |
Devuelve información sobre un fondo. |
| Obtener un paquete |
Devuelve información sobre un paquete. |
| Obtener una apelación |
Devuelve información sobre una apelación. |
| Obtener una campaña |
Devuelve información sobre una campaña. |
Actualización de datos adjuntos de apelación
Actualiza los datos adjuntos de una apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de datos adjuntos
|
attachment_id | True | string |
Identificador de registro del sistema de los datos adjuntos que se van a actualizar. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Actualización de un campo personalizado de apelación
Actualiza un campo personalizado de apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campo personalizado
|
custom_field_id | True | string |
Identificador de registro del sistema del campo personalizado que se va a actualizar. |
|
body
|
body | True | dynamic |
Objeto que representa las propiedades del campo personalizado que se va a actualizar. |
Actualización de una apelación
Actualiza una apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de apelación
|
id | True | integer |
Identificador de registro del sistema de la apelación que se va a actualizar. |
|
Identificador de búsqueda
|
appeal_id | string |
Identificador definido por el usuario para la apelación. |
|
|
Description
|
description | string |
Descripción del recurso. |
|
|
Fecha de inicio
|
start_date | date |
Fecha de inicio del recurso (por ejemplo: «2005-09-18»). |
|
|
Fecha de finalización
|
end_date | date |
Fecha de finalización del recurso (por ejemplo: "2005-09-18"). |
|
|
Categoría
|
appeal_category_id | integer |
Categoría de apelación. |
|
|
Objetivo
|
goal | double |
Importe objetivo que se va a elevar a través del recurso. |
|
|
Cantidad de regalo predeterminada
|
default_gift_amount | double |
Cantidad monetaria del regalo predeterminado. Esta propiedad tiene como valor predeterminado 0,00 si no se especifica ninguna cantidad. |
|
|
Número solicitado
|
number_solicited | integer |
Número de constituyentes solicitados en el recurso de casación. |
|
|
Notas
|
notes | string |
Las notas asociadas al recurso. |
|
|
Identificador de campaña predeterminado
|
campaign_id | integer |
Identificador de una campaña asociada a la apelación. |
|
|
Identificador de fondo predeterminado
|
default_fund_id | integer |
El identificador del fondo predeterminado asociado al recurso. |
|
|
¿Inactivo?
|
inactive | boolean |
¿El recurso está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
Actualización de una apelación constituyente
Actualiza una apelación constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de recurso que constituye un identificador de apelación
|
id | True | integer |
Identificador de registro del sistema del recurso constituyente que se va a actualizar. |
|
Descripción de la apelación
|
appeal_description | string |
La descripción del recurso; se usa para buscar el identificador del registro de apelación. |
|
|
Descripción del paquete
|
package_description | string |
Descripción del paquete; se usa para buscar el identificador de registro del paquete. |
|
|
Fecha
|
appeal_date | date |
La fecha del recurso constituyente (por ejemplo: '2005-09-18'). |
|
|
Respuesta
|
response_description | string |
La larga descripción de la respuesta del recurso constituyente. |
|
|
Segmento de marketing
|
marketing_segment | string |
El segmento de marketing asociado al recurso constituyente. |
|
|
Código fuente de marketing
|
marketing_source_code | string |
Código fuente de marketing asociado al recurso constituyente. |
|
|
Id. de correo
|
mailing_id | integer |
El identificador de correo del recurso constituyente. |
|
|
Número del buscador
|
market_finder_number | string |
Número de buscador de mercado asociado al recurso constituyente. |
|
|
Comentarios
|
comments | string |
Las observaciones asociadas al recurso constituyente. |
Actualizar datos adjuntos de un fondo
Actualiza un fondo adjunto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de datos adjuntos
|
attachment_id | True | string |
Identificador de registro del sistema de los datos adjuntos que se van a actualizar. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Actualizar datos adjuntos de una campaña
Actualiza los datos adjuntos de una campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de datos adjuntos
|
attachment_id | True | string |
Identificador de registro del sistema de los datos adjuntos que se van a actualizar. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Actualizar un campo personalizado de campaña
Actualiza un campo personalizado de campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campo personalizado
|
custom_field_id | True | string |
Identificador de registro del sistema del campo personalizado que se va a actualizar. |
|
body
|
body | True | dynamic |
Objeto que representa las propiedades del campo personalizado que se va a actualizar. |
Actualizar un campo personalizado de fondo
Actualiza un campo personalizado de fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campo personalizado
|
custom_field_id | True | string |
Identificador de registro del sistema del campo personalizado que se va a actualizar. |
|
body
|
body | True | dynamic |
Objeto que representa las propiedades del campo personalizado que se va a actualizar. |
Actualizar un fondo
Actualiza un fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del fondo
|
id | True | integer |
Identificador de registro del sistema del fondo que se va a actualizar. |
|
Identificador de búsqueda
|
fund_id | string |
Identificador definido por el usuario para el fondo. |
|
|
Description
|
description | string |
Descripción del fondo. |
|
|
Fecha de inicio
|
start_date | date |
Fecha de inicio del fondo (por ejemplo: "2005-09-18"). |
|
|
Fecha de finalización
|
end_date | date |
Fecha de finalización del fondo (por ejemplo: "2005-09-18"). |
|
|
Categoría
|
fund_category_id | integer |
Categoría del fondo. |
|
|
Tipo
|
fund_type_id | integer |
Tipo de fondo. |
|
|
Objetivo
|
goal | double |
Importe objetivo que se va a aumentar para el fondo. |
|
|
Notas
|
notes | string |
Notas asociadas al fondo. |
|
|
¿Restringido?
|
restricted | boolean |
¿El fondo está restringido a usuarios específicos? |
|
|
¿Inactivo?
|
inactive | boolean |
¿El fondo está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
|
Identificador de campaña
|
campaign_id | integer |
Identificador de una campaña asociada al fondo. |
|
|
Identificador de apelación predeterminado
|
default_appeal_id | integer |
El identificador de la apelación predeterminada asociada al fondo. |
Actualizar una campaña
Actualiza una campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
id | True | integer |
Identificador de registro del sistema de la campaña que se va a actualizar. |
|
Identificador de búsqueda
|
campaign_id | string |
Identificador definido por el usuario para la campaña. |
|
|
Description
|
description | string |
Descripción de la campaña. |
|
|
Fecha de inicio
|
start_date | date |
Fecha de inicio de la campaña (por ejemplo: '2005-09-18'). |
|
|
Fecha de finalización
|
end_date | date |
Fecha de finalización de la campaña (por ejemplo: '2005-09-18'). |
|
|
Categoría
|
campaign_category_id | integer |
Categoría de campaña. |
|
|
Objetivo
|
goal | double |
Cantidad objetivo que se va a aumentar a través de la campaña. |
|
|
Notas
|
notes | string |
Notas asociadas a la campaña. |
|
|
¿Inactivo?
|
inactive | boolean |
¿La campaña está inactiva (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
|
Identificador de fondo predeterminado
|
default_fund_id | integer |
Identificador del fondo predeterminado asociado a la campaña. |
Creación de datos adjuntos de apelación
Crea un nuevo archivo adjunto de apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de apelación
|
parent_id | True | string |
Identificador de registro del sistema del recurso asociado a los datos adjuntos. |
|
Tipo
|
type | True | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). Este campo tiene como valor predeterminado la fecha y hora actuales si no se proporciona. |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Devoluciones
Datos adjuntos de apelación creados
Creación de un campo personalizado de apelación
Crea un nuevo campo personalizado de atractivo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objeto que representa el campo personalizado que se va a crear. |
Devoluciones
Campo personalizado de apelación creado
Creación de un campo personalizado de fondo
Crea un nuevo campo personalizado de fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objeto que representa el campo personalizado que se va a crear. |
Devoluciones
Campo personalizado de fondo creado
Creación de un recurso constituyente
Crea un nuevo recurso constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | integer |
El identificador de registro del sistema del constituyente asociado al recurso constituyente. |
|
Descripción de la apelación
|
appeal_description | True | string |
La descripción del recurso; se usa para buscar el identificador del registro de apelación. |
|
Descripción del paquete
|
package_description | string |
Descripción del paquete; se usa para buscar el identificador de registro del paquete. |
|
|
Fecha
|
appeal_date | date |
La fecha del recurso constituyente (por ejemplo: '2005-09-18'). |
|
|
Respuesta
|
response_description | string |
La larga descripción de la respuesta del recurso constituyente. |
|
|
Segmento de marketing
|
marketing_segment | string |
El segmento de marketing asociado al recurso constituyente. |
|
|
Código fuente de marketing
|
marketing_source_code | string |
Código fuente de marketing asociado al recurso constituyente. |
|
|
Id. de correo
|
mailing_id | integer |
El identificador de correo del recurso constituyente. |
|
|
Número del buscador
|
market_finder_number | string |
Número de buscador de mercado asociado al recurso constituyente. |
|
|
Comentarios
|
comments | string |
Las observaciones asociadas al recurso constituyente. |
|
|
Id. de importación
|
import_id | string |
Identificador de importación del recurso constituyente. |
Devoluciones
Creación de una apelación constituyente
Creación de una apelación
Crea una nueva apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de búsqueda
|
appeal_id | True | string |
Identificador definido por el usuario para la apelación. |
|
Description
|
description | True | string |
Descripción del recurso. |
|
Fecha de inicio
|
start_date | date |
Fecha de inicio del recurso (por ejemplo: «2005-09-18»). |
|
|
Fecha de finalización
|
end_date | date |
Fecha de finalización del recurso (por ejemplo: "2005-09-18"). |
|
|
Categoría
|
appeal_category_id | integer |
Categoría de apelación. |
|
|
Objetivo
|
goal | double |
Importe objetivo que se va a elevar a través del recurso. |
|
|
Cantidad de regalo predeterminada
|
default_gift_amount | double |
Cantidad monetaria del regalo predeterminado. Esta propiedad tiene como valor predeterminado 0,00 si no se especifica ninguna cantidad. |
|
|
Número solicitado
|
number_solicited | integer |
Número de constituyentes solicitados en el recurso de casación. |
|
|
Notas
|
notes | string |
Las notas asociadas al recurso. |
|
|
Identificador de campaña predeterminado
|
campaign_id | integer |
Identificador de una campaña asociada a la apelación. |
|
|
Identificador de fondo predeterminado
|
default_fund_id | integer |
El identificador del fondo predeterminado asociado al recurso. |
|
|
¿Inactivo?
|
inactive | boolean |
¿El recurso está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
Devoluciones
Recurso creado
Crear datos adjuntos de campaña
Crea datos adjuntos de campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
parent_id | True | string |
Identificador de registro del sistema de la campaña asociada a los datos adjuntos. |
|
Tipo
|
type | True | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). Este campo tiene como valor predeterminado la fecha y hora actuales si no se proporciona. |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Devoluciones
Datos adjuntos de campaña creados
Crear un campo personalizado de campaña
Crea un nuevo campo personalizado de campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
Objeto que representa el campo personalizado que se va a crear. |
Devoluciones
Campo personalizado de campaña creado
Crear un fondo
Crea un nuevo fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de búsqueda
|
fund_id | True | string |
Identificador definido por el usuario para el fondo. |
|
Description
|
description | True | string |
Descripción del fondo. |
|
Fecha de inicio
|
start_date | date |
Fecha de inicio del fondo (por ejemplo: "2005-09-18"). |
|
|
Fecha de finalización
|
end_date | date |
Fecha de finalización del fondo (por ejemplo: "2005-09-18"). |
|
|
Categoría
|
fund_category_id | integer |
Categoría del fondo. |
|
|
Tipo
|
fund_type_id | integer |
Tipo de fondo. |
|
|
Objetivo
|
goal | double |
Importe objetivo que se va a aumentar para el fondo. |
|
|
Notas
|
notes | string |
Notas asociadas al fondo. |
|
|
¿Restringido?
|
restricted | boolean |
¿El fondo está restringido a usuarios específicos? |
|
|
¿Inactivo?
|
inactive | boolean |
¿El fondo está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
|
Identificador de campaña
|
campaign_id | integer |
Identificador de una campaña asociada al fondo. |
|
|
Identificador de apelación predeterminado
|
default_appeal_id | integer |
El identificador de la apelación predeterminada asociada al fondo. |
Devoluciones
Fondo creado
Crear un fondo adjunto
Crea un nuevo fondo adjunto.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del fondo
|
parent_id | True | string |
Identificador de registro del sistema del fondo asociado a los datos adjuntos. |
|
Tipo
|
type | True | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
|
Fecha
|
date | date-time |
La fecha de los datos adjuntos (por ejemplo: '2020-09-18T04:13:56Z'). Este campo tiene como valor predeterminado la fecha y hora actuales si no se proporciona. |
|
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Devoluciones
Datos adjuntos de fondos creados
Crear una campaña
Crea una nueva campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de búsqueda
|
campaign_id | True | string |
Identificador definido por el usuario para la campaña. |
|
Description
|
description | True | string |
Descripción de la campaña. |
|
Fecha de inicio
|
start_date | date |
Fecha de inicio de la campaña (por ejemplo: '2005-09-18'). |
|
|
Fecha de finalización
|
end_date | date |
Fecha de finalización de la campaña (por ejemplo: '2005-09-18'). |
|
|
Categoría
|
campaign_category_id | integer |
Categoría de campaña. |
|
|
Objetivo
|
goal | double |
Cantidad objetivo que se va a aumentar a través de la campaña. |
|
|
Notas
|
notes | string |
Notas asociadas a la campaña. |
|
|
¿Inactivo?
|
inactive | boolean |
¿La campaña está inactiva (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
|
Identificador de fondo predeterminado
|
default_fund_id | integer |
Identificador del fondo predeterminado asociado a la campaña. |
Devoluciones
Campaña creada
Enumerar campañas
Devuelve una lista de campañas.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 5000. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
|
|
¿Incluir inactivo?
|
include_inactive | boolean |
¿Incluye campañas inactivas? |
|
|
Agregado en o después
|
date_added | date-time |
Filtre los resultados de las campañas creadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z"). |
|
|
Modificado en o después
|
last_modified | date-time |
Filtre los resultados de las campañas modificadas en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
Devoluciones
Campañas
Enumerar campos personalizados de atractivo
Enumera los campos personalizados de una apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de apelación
|
appeal_id | True | string |
El identificador de registro del sistema del recurso. |
Devoluciones
Campos personalizados
Enumerar campos personalizados de campaña
Enumera los campos personalizados de una campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
campaign_id | True | string |
Identificador de registro del sistema de la campaña. |
Devoluciones
Campos personalizados
Enumerar campos personalizados del fondo
Enumera los campos personalizados de un fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo. |
Devoluciones
Campos personalizados
Enumerar datos adjuntos de campaña
Enumera los datos adjuntos de una campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
campaign_id | True | string |
Identificador de registro del sistema de la campaña. |
Devoluciones
Attachments
Enumerar datos adjuntos de fondos
Enumera los datos adjuntos de un fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo. |
Devoluciones
Attachments
Enumerar fondos
Devuelve una lista de fondos.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 5000. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
|
|
¿Incluir inactivo?
|
include_inactive | boolean |
¿Incluir fondos inactivos? |
|
|
Agregado en o después
|
date_added | date-time |
Filtre los resultados a los fondos creados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
|
|
Modificado en o después
|
last_modified | date-time |
Filtre los resultados a fondos modificados en o después de la fecha especificada (por ejemplo: '2020-09-18T04:13:56Z'). |
Devoluciones
Fondos
Enumerar las apelaciones
Devuelve una lista de apelaciones.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 5000. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
|
|
¿Incluir inactivo?
|
include_inactive | boolean |
¿Incluir apelaciones inactivas? |
|
|
Agregado en o después
|
date_added | date-time |
Filtre los resultados de las apelaciones creadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z"). |
|
|
Modificado en o después
|
last_modified | date-time |
Filtre los resultados de las apelaciones modificadas en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z"). |
Devoluciones
Apelaciones
Enumerar las apelaciones constituyentes
Enumera los llamamientos para un constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituent_id | True | string |
Identificador de registro del sistema del constituyente. |
Devoluciones
Apelaciones constituyentes
Enumerar las relaciones constituyentes del fondo
Enumera las relaciones constituyentes de un fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del fondo
|
fundId | True | integer |
Identificador de registro del sistema del fondo. |
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
Devoluciones
Relaciones constituyentes
Enumerar las relaciones de los fondos constituyentes
Enumera las relaciones de fondo para un constituyente.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador constituyente
|
constituentId | True | integer |
Identificador de registro del sistema del constituyente. |
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
Devoluciones
Relaciones con fondos
Enumerar los datos adjuntos de la apelación
Enumera los datos adjuntos de una apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de apelación
|
appeal_id | True | string |
El identificador de registro del sistema del recurso. |
Devoluciones
Attachments
Enumerar paquetes
Devuelve una lista de paquetes.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de apelación
|
appeal_id | string |
Representa una lista separada por comas de identificadores de registro del sistema de apelación para filtrar los resultados. Por ejemplo, "506,918" devuelve solo paquetes de apelación 506 o apelación 918. |
|
|
Limit
|
limit | integer |
Representa el número de registros que se van a devolver. El valor predeterminado es 500. El máximo es 5000. |
|
|
Desplazar
|
offset | integer |
Representa el número de registros que se van a omitir. Para su uso con paginación. |
|
|
¿Incluir inactivo?
|
include_inactive | boolean |
¿Incluye paquetes inactivos? |
|
|
Agregado en o después
|
date_added | date-time |
Filtre los resultados a los paquetes creados en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z"). |
|
|
Modificado en o después
|
last_modified | date-time |
Filtre los resultados a los paquetes modificados en o después de la fecha especificada (por ejemplo: "2020-09-18T04:13:56Z"). |
Devoluciones
Packages
Obtener un fondo
Devuelve información sobre un fondo.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. del fondo
|
fund_id | True | string |
Identificador de registro del sistema del fondo que se va a obtener. |
Devoluciones
Fondo
Obtener un paquete
Devuelve información sobre un paquete.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de paquete
|
package_id | True | string |
Identificador de registro del sistema del paquete que se va a obtener. |
Devoluciones
Package
Obtener una apelación
Devuelve información sobre una apelación.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Id. de apelación
|
appeal_id | True | string |
Identificador de registro del sistema del recurso que se va a obtener. |
Devoluciones
Appeal
Obtener una campaña
Devuelve información sobre una campaña.
Parámetros
| Nombre | Clave | Requerido | Tipo | Description |
|---|---|---|---|---|
|
Identificador de campaña
|
campaign_id | True | string |
Identificador de registro del sistema de la campaña que se va a obtener. |
Devoluciones
Campaña
Definiciones
ConstituentApi.ApiCollectionOfConstituentAppealRead
Apelaciones constituyentes
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of ConstituentApi.ConstituentAppealRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
ConstituentApi.ConstituentAppealRead
Apelación constituyente
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El identificador de registro del sistema del recurso constituyente. |
|
identificación
|
appeal.id | string |
El identificador de registro del sistema del recurso. |
|
descripción
|
appeal.description | string |
Descripción del recurso. |
|
identificación
|
package.id | string |
Identificador de registro del sistema del paquete. |
|
descripción
|
package.description | string |
Descripción del paquete. |
|
Fecha
|
date | date-time |
Fecha de apelación constituyente. |
|
Respuesta
|
response | string |
La respuesta del recurso constituyente. |
|
Segmento de marketing
|
marketing_segment | string |
Segmento de marketing para el recurso constituyente. |
|
Código fuente de marketing
|
marketing_source_code | string |
Código fuente de marketing para el recurso constituyente. |
|
Id. de correo
|
mailing_id | string |
Identificador de correo definido por el usuario para el recurso constituyente. |
|
Número del buscador
|
finder_number | string |
Número de buscador de marketing para el recurso constituyente. |
|
Comentarios
|
comments | string |
Comentarios del usuario para el llamamiento constituyente. |
Recaudación de fondosApi.ApiCollectionOfAppealAttachmentRead
Attachments
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.AppealAttachmentRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfAppealCustomFieldRead
Campos personalizados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.AppealCustomFieldRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfAppealRead
Apelaciones
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.AppealRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfCampaignAttachmentRead
Attachments
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.CampaignAttachmentRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfCampaignCustomFieldRead
Campos personalizados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.CampaignCustomFieldRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfCampaignRead
Campañas
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.CampaignRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfFundAttachmentRead
Attachments
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.FundAttachmentRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfFundCustomFieldRead
Campos personalizados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.FundCustomFieldRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfFundRead
Fondos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.FundRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.ApiCollectionOfPackageRead
Packages
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of FundraisingApi.PackageRead |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
Recaudación de fondosApi.AppealAttachmentRead
Datos adjuntos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de los datos adjuntos. |
|
Id. de apelación
|
parent_id | string |
Identificador de registro del sistema del recurso asociado a los datos adjuntos. |
|
Tipo
|
type | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
Fecha
|
date | date-time |
Fecha de los datos adjuntos. |
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Url de miniatura
|
thumbnail_url | string |
Dirección URL de una miniatura. Solo para los datos adjuntos físicos que son imágenes. Contiene una firma enlazada a tiempo que limita el acceso a 60 minutos. |
|
Tipo de contenido
|
content_type | string |
Tipo de contenido. Solo para datos adjuntos físicos. |
|
Tamaño de archivo
|
file_size | integer |
Tamaño del archivo en bytes. Solo para datos adjuntos físicos. |
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Recaudación de fondosApi.AppealCustomFieldRead
Campo personalizado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del campo personalizado. |
|
Id. de apelación
|
parent_id | string |
Identificador de registro del sistema del recurso asociado al campo personalizado. |
|
Categoría
|
category | string |
Categoría de campo personalizado. |
|
Tipo
|
type | string |
Tipo de datos que representa el campo personalizado. |
|
Importancia
|
value |
Valor del campo personalizado. |
|
|
Valor de texto
|
text_value | string |
Valor de texto del campo personalizado. |
|
Valor de número
|
number_value | integer |
Valor numérico del campo personalizado. |
|
Valor de fecha
|
date_value | date |
Valor de fecha del campo personalizado. |
|
Valor de moneda
|
currency_value | double |
Valor de moneda del campo personalizado. |
|
Valor booleano
|
boolean_value | boolean |
Valor booleano del campo personalizado. |
|
Valor de entrada de tabla
|
codetableentry_value | string |
Valor de entrada de tabla del campo personalizado. |
|
Valor de id. constituyente
|
constituentid_value | string |
Valor de identificador constituyente del campo personalizado. |
|
Día
|
fuzzydate_value.d | integer |
El día en la fecha aproximada. |
|
month
|
fuzzydate_value.m | integer |
Mes en la fecha aproximada. |
|
año
|
fuzzydate_value.y | integer |
Año en la fecha aproximada. |
|
Fecha
|
date | date |
Fecha en el campo personalizado. |
|
Comentario
|
comment | string |
Comentario en el campo personalizado. Límite de caracteres: 50. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el campo personalizado. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en que se modificó por última vez el campo personalizado. |
Recaudación de fondosApi.AppealRead
Appeal
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El identificador de registro del sistema del recurso. |
|
Categoría
|
category | string |
Categoría del recurso. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó la apelación. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en que se modificó por última vez la apelación. |
|
Description
|
description | string |
Nombre para mostrar del recurso. |
|
Fecha de finalización
|
end_date | date-time |
Fecha de finalización del recurso. |
|
value
|
goal.value | double |
Valor monetario. |
|
¿Inactivo?
|
inactive | boolean |
¿Está activa la apelación (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para la apelación. |
|
Fecha de inicio
|
start_date | date-time |
Fecha de inicio del recurso. |
Recaudación de fondosApi.CampaignAttachmentRead
Datos adjuntos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de los datos adjuntos. |
|
Identificador de campaña
|
parent_id | string |
Identificador de registro del sistema de la campaña asociada a los datos adjuntos. |
|
Tipo
|
type | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
Fecha
|
date | date-time |
Fecha de los datos adjuntos. |
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Url de miniatura
|
thumbnail_url | string |
Dirección URL de una miniatura. Solo para los datos adjuntos físicos que son imágenes. Contiene una firma enlazada a tiempo que limita el acceso a 60 minutos. |
|
Tipo de contenido
|
content_type | string |
Tipo de contenido. Solo para datos adjuntos físicos. |
|
Tamaño de archivo
|
file_size | integer |
Tamaño del archivo en bytes. Solo para datos adjuntos físicos. |
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Recaudación de fondosApi.CampaignCustomFieldRead
Campo personalizado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del campo personalizado. |
|
Identificador de campaña
|
parent_id | string |
Identificador de registro del sistema de la campaña asociada al campo personalizado. |
|
Categoría
|
category | string |
Categoría de campo personalizado. |
|
Tipo
|
type | string |
Tipo de datos que representa el campo personalizado. |
|
Importancia
|
value |
Valor del campo personalizado. |
|
|
Valor de texto
|
text_value | string |
Valor de texto del campo personalizado. |
|
Valor de número
|
number_value | integer |
Valor numérico del campo personalizado. |
|
Valor de fecha
|
date_value | date |
Valor de fecha del campo personalizado. |
|
Valor de moneda
|
currency_value | double |
Valor de moneda del campo personalizado. |
|
Valor booleano
|
boolean_value | boolean |
Valor booleano del campo personalizado. |
|
Valor de entrada de tabla
|
codetableentry_value | string |
Valor de entrada de tabla del campo personalizado. |
|
Valor de id. constituyente
|
constituentid_value | string |
Valor de identificador constituyente del campo personalizado. |
|
Día
|
fuzzydate_value.d | integer |
El día en la fecha aproximada. |
|
month
|
fuzzydate_value.m | integer |
Mes en la fecha aproximada. |
|
año
|
fuzzydate_value.y | integer |
Año en la fecha aproximada. |
|
Fecha
|
date | date |
Fecha en el campo personalizado. |
|
Comentario
|
comment | string |
Comentario en el campo personalizado. Límite de caracteres: 50. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el campo personalizado. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en que se modificó por última vez el campo personalizado. |
Recaudación de fondosApi.CampaignRead
Campaña
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de la campaña. |
|
Categoría
|
category | string |
Categoría de la campaña. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó la campaña. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en la que se modificó por última vez la campaña. |
|
Description
|
description | string |
Nombre para mostrar de la campaña. |
|
Fecha de finalización
|
end_date | date-time |
Fecha de finalización de la campaña. |
|
value
|
goal.value | double |
Valor monetario. |
|
¿Inactivo?
|
inactive | boolean |
¿La campaña está inactiva (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para la campaña. |
|
Fecha de inicio
|
start_date | date-time |
Fecha de inicio de la campaña. |
Recaudación de fondosApi.CreatedAppealAttachment
Datos adjuntos de apelación creados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de los datos adjuntos de apelación recién creados. |
Recaudación de fondosApi.CreatedAppealCustomField
Campo personalizado de apelación creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del campo personalizado de apelación recién creado. |
Recaudación de fondosApi.CreatedCampaignAttachment
Datos adjuntos de campaña creados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de los datos adjuntos de la campaña recién creada. |
Recaudación de fondosApi.CreatedCampaignCustomField
Campo personalizado de campaña creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del campo personalizado de campaña recién creado. |
Recaudación de fondosApi.CreatedFundAttachment
Datos adjuntos de fondos creados
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de los datos adjuntos del fondo recién creado. |
Recaudación de fondosApi.CreatedFundCustomField
Campo personalizado de fondo creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del campo personalizado del fondo recién creado. |
Recaudación de fondosApi.FundAttachmentRead
Datos adjuntos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema de los datos adjuntos. |
|
Id. del fondo
|
parent_id | string |
Identificador de registro del sistema del fondo asociado a los datos adjuntos. |
|
Tipo
|
type | string |
Tipo de datos adjuntos. Los datos adjuntos físicos se cargan archivos como imágenes, ARCHIVOS PDF o documentos de Word que se guardan localmente o en la red. Se almacenan y administran en el sistema. Los datos adjuntos de vínculo son vínculos a archivos como imágenes, entradas de blog o vídeos de YouTube que están en línea o en una cuenta de almacenamiento en la nube. Se almacenan y administran externamente. |
|
Nombre
|
name | string |
El nombre de los datos adjuntos. Límite de caracteres: 150. |
|
Fecha
|
date | date-time |
Fecha de los datos adjuntos. |
|
URL
|
url | string |
Dirección URL de los datos adjuntos. Esto es necesario para los datos adjuntos de vínculo y no para los datos adjuntos físicos. |
|
Nombre del archivo
|
file_name | string |
El nombre del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de archivo
|
file_id | string |
Identificador del archivo. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Id. de miniatura
|
thumbnail_id | string |
Identificador de la miniatura. Límite de caracteres: 36. Solo para datos adjuntos físicos. |
|
Url de miniatura
|
thumbnail_url | string |
Dirección URL de una miniatura. Solo para los datos adjuntos físicos que son imágenes. Contiene una firma enlazada a tiempo que limita el acceso a 60 minutos. |
|
Tipo de contenido
|
content_type | string |
Tipo de contenido. Solo para datos adjuntos físicos. |
|
Tamaño de archivo
|
file_size | integer |
Tamaño del archivo en bytes. Solo para datos adjuntos físicos. |
|
Etiquetas
|
tags | array of string |
Etiquetas asociadas a los datos adjuntos. |
Recaudación de fondosApi.FundCustomFieldRead
Campo personalizado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del campo personalizado. |
|
Id. del fondo
|
parent_id | string |
Identificador de registro del sistema del fondo asociado al campo personalizado. |
|
Categoría
|
category | string |
Categoría de campo personalizado. |
|
Tipo
|
type | string |
Tipo de datos que representa el campo personalizado. |
|
Importancia
|
value |
Valor del campo personalizado. |
|
|
Valor de texto
|
text_value | string |
Valor de texto del campo personalizado. |
|
Valor de número
|
number_value | integer |
Valor numérico del campo personalizado. |
|
Valor de fecha
|
date_value | date |
Valor de fecha del campo personalizado. |
|
Valor de moneda
|
currency_value | double |
Valor de moneda del campo personalizado. |
|
Valor booleano
|
boolean_value | boolean |
Valor booleano del campo personalizado. |
|
Valor de entrada de tabla
|
codetableentry_value | string |
Valor de entrada de tabla del campo personalizado. |
|
Valor de id. constituyente
|
constituentid_value | string |
Valor de identificador constituyente del campo personalizado. |
|
Día
|
fuzzydate_value.d | integer |
El día en la fecha aproximada. |
|
month
|
fuzzydate_value.m | integer |
Mes en la fecha aproximada. |
|
año
|
fuzzydate_value.y | integer |
Año en la fecha aproximada. |
|
Fecha
|
date | date |
Fecha en el campo personalizado. |
|
Comentario
|
comment | string |
Comentario en el campo personalizado. Límite de caracteres: 50. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el campo personalizado. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en que se modificó por última vez el campo personalizado. |
Recaudación de fondosApi.FundRead
Fondo
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del fondo. |
|
Categoría
|
category | string |
Categoría del fondo. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el fondo. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en la que se modificó por última vez el fondo. |
|
Description
|
description | string |
Nombre para mostrar del fondo. |
|
Fecha de finalización
|
end_date | date-time |
Fecha de finalización del fondo. |
|
value
|
goal.value | double |
Valor monetario. |
|
¿Inactivo?
|
inactive | boolean |
¿El fondo está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el fondo. |
|
Fecha de inicio
|
start_date | date-time |
Fecha de inicio del fondo. |
|
Tipo
|
type | string |
Tipo del fondo. |
Recaudación de fondosApi.PackageRead
Package
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de registro del sistema del paquete. |
|
Id. de apelación
|
appeal_id | string |
Identificador de registro del sistema del recurso asociado a este paquete. |
|
Categoría
|
category | string |
Categoría del paquete. |
|
Fecha de adición
|
date_added | date-time |
Fecha en que se creó el paquete. |
|
Fecha de modificación
|
date_modified | date-time |
Fecha en la que se modificó por última vez el paquete. |
|
value
|
default_gift_amount.value | double |
Valor monetario. |
|
Description
|
description | string |
Nombre para mostrar del paquete. |
|
Fecha de finalización
|
end | date-time |
Fecha de finalización del paquete. |
|
value
|
goal.value | double |
Valor monetario. |
|
¿Inactivo?
|
inactive | boolean |
¿El paquete está inactivo (es decir, la fecha actual es posterior a cualquier fecha de inicio y antes de cualquier fecha de finalización)? |
|
Identificador de búsqueda
|
lookup_id | string |
Identificador definido por el usuario para el paquete. |
|
Notas
|
notes | string |
Notas del paquete. |
|
Recuento de destinatarios
|
recipient_count | integer |
Número de destinatarios del paquete. |
|
Fecha de inicio
|
start | date-time |
Fecha de inicio del paquete. |
AUTOMATICDataIntegrationApi.ConstituentRelationship
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Identificador constituyente
|
relation_id | integer |
Identificador de registro del sistema del componente relacionado. |
|
Descripción de la relación
|
relation_description | string |
Descripción de la relación. |
|
Tipo de relación
|
relationship_type | string |
Tipo de relación. |
|
Tipo de relación recíproca
|
reciprocal_relationship_type | string |
Tipo de relación recíproca. |
|
Fecha de
|
date_from | date-time |
Fecha de inicio de la relación. |
|
Fecha a
|
date_to | date-time |
Fecha de finalización de la relación. |
|
Notas
|
notes | string |
Notas de la relación. |
LISTDataIntegrationApi.ConstituentRelationshipCollection
Relaciones constituyentes
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of NXTDataIntegrationApi.ConstituentRelationship |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |
CREATEDataIntegrationApi.CreatedAppeal
Recurso creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del recurso recién creado. |
ALLAHDataIntegrationApi.CreatedCampaign
Campaña creada
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador de la campaña recién creada. |
CREATEDataIntegrationApi.CreatedConstituentAppeal
Creación de una apelación constituyente
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
El identificador del recurso constituyente recién creado. |
AUTOMATICDataIntegrationApi.CreatedFund
Fondo creado
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
identificación
|
id | string |
Identificador del fondo recién creado. |
AUTOMATICDataIntegrationApi.FundRelationship
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Id. del fondo
|
relation_id | integer |
Identificador de registro del sistema del fondo relacionado. |
|
Descripción de la relación
|
relation_description | string |
Descripción de la relación. |
|
Tipo de relación
|
relationship_type | string |
Tipo de relación. |
|
Tipo de relación recíproca
|
reciprocal_relationship_type | string |
Tipo de relación recíproca. |
|
Fecha de
|
date_from | date-time |
Fecha de inicio de la relación. |
|
Fecha a
|
date_to | date-time |
Fecha de finalización de la relación. |
|
Notas
|
notes | string |
Notas de la relación. |
AUTOMATICDataIntegrationApi.FundRelationshipCollection
Relaciones con fondos
| Nombre | Ruta de acceso | Tipo | Description |
|---|---|---|---|
|
Contar
|
count | integer |
Número de elementos disponibles para la recuperación en la colección después de aplicar los parámetros de solicitud. Los parámetros de límite y desplazamiento no afectan al recuento, pero para facilitar la paginación, pueden afectar al número de elementos del conjunto de resultados de valor. |
|
value
|
value | array of NXTDataIntegrationApi.FundRelationship |
Conjunto de elementos incluidos en la respuesta. Puede ser un subconjunto de los elementos de la colección. |