Blackbaud Raisers Edge NXT 구성 요소
Blackbaud Raiser's Edge NXT는 비영리 단체와 전체 사회적 선의의 커뮤니티를 위해 특별히 구축된 포괄적인 클라우드 기반 모금 및 기부자 관리 소프트웨어 솔루션입니다. 구성 요소 커넥터를 사용하여 구성 전기 정보, 연락처 정보 및 관계를 관리합니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | - | 사용할 수 없음 |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | Blackbaud 지원 |
| URL | https://www.blackbaud.com/support |
| 전자 메일 | skyapi@blackbaud.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Blackbaud, Inc. |
| 웹 사이트 | https://www.blackbaud.com/products/blackbaud-raisers-edge-nxt |
| 개인 정보 보호 정책 | https://www.blackbaud.com/privacy-shield |
| 카테고리 | 판매 및 CRM; 생산력 |
Raiser's Edge NXT 는 비영리 단체와 전체 사회적 선의의 커뮤니티를 위해 특별히 구축된 포괄적인 클라우드 기반 모금 및 기부자 관리 소프트웨어 솔루션입니다.
이 커넥터는 Blackbaud의 SKY API를 기반으로 하며 다음을 포함하여 Raiser의 Edge NXT 내에 있는 구성 요소 및 관련 엔터티를 관리하는 데 도움이 되는 작업을 제공합니다.
- 성분
- Addresses
- 휴대폰 및 전자 메일
- Aliases
- 사용자 지정 필드
- 비고
- Attachments
- 관계
- 그 외의 여러 작업...
자세한 내용은 설명서를 참조하세요.
필수 조건
이 커넥터를 사용하려면 하나 이상의 Blackbaud 환경에 액세스할 수 있는 Blackbaud ID 계정이 있어야 합니다.
또한 조직의 관리자는 이 커넥터가 Blackbaud 환경에 액세스할 수 있도록 시스템 내에서 관리자 수준 작업을 수행해야 합니다. 이러한 필수 구성 요소에 대한 자세한 내용은 초기 설치 설명서에서 확인할 수 있습니다.
자격 증명을 가져오는 방법
조직의 관리자는 조직의 Raiser Edge NXT 환경에 초대를 보내고 환경 내에서 사용자 계정 권한을 구성합니다. 이 커넥터를 사용하려면 추가 자격 증명이 필요하지 않습니다.
알려진 문제 및 제한 사항
커넥터는 사용자 계정의 컨텍스트에서 작동하므로 환경 내에서 사용자 권한이 적용됩니다.
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| 개별 관계 만들기 |
새 개별 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다. |
| 개별 구성 요소 만들기 |
새 개별 구성 요소를 만듭니다. |
| 공물 승인 만들기 |
새 공물 승인을 만듭니다. |
| 구성 교육 만들기 |
새 구성 교육을 만듭니다. |
| 구성 교육 목록 |
구성 요소에 대한 교육 레코드를 나열합니다. |
| 구성 교육 업데이트 |
구성 교육을 업데이트합니다. |
| 구성 요소 가져오기 |
구성 요소에 대한 정보를 반환합니다. |
| 구성 요소 검색 |
제공된 검색 텍스트를 기반으로 구성 요소 검색을 수행합니다. 이름, 성, 기본 설정 이름, 이전 이름, 별칭, 전자 메일 주소, 전화 번호, 주소 또는 조회 ID를 지원합니다. 이름, 성, 기본 이름 및 성 등의 이름 조합은 유효하지만, 그렇지 않으면 검색에서 한 번에 하나의 매개 변수만 지원합니다. 기본적으로 검색에는 조건과 비슷한 결과가 포함됩니다. 예를 들어 "Smith"에 대한 검색에는 "Smyth" 및 기타 대체 맞춤법의 일치 항목이 포함됩니다. 이 검색은 * 또는 ?와 같은 와일드카드 문자를 지원하지 않습니다. 검색 결과는 500개 레코드로 제한됩니다. |
| 구성 요소 검색(향상된) |
지정된 필터 조건을 사용하여 구성 레코드를 검색합니다. |
| 구성 요소 공물 가져오기 |
구성 요소 공물의 세부 정보를 반환합니다. |
| 구성 요소 공물 나열 |
구성 요소에 대한 공물을 나열합니다. |
| 구성 요소 공물 만들기 |
새 구성 요소 공물을 만듭니다. |
| 구성 요소 관계 나열 |
구성 요소의 관계를 나열합니다. |
| 구성 요소 관계 업데이트 |
구성 요소에 대한 관계를 업데이트합니다. 상호 관계가 있는 경우 변경 내용을 반영하도록 수정됩니다. 여기에는 각 레코드와 관련이 있으며 각 레코드에서 독립적으로 수정할 수 있는 "comments" 속성에 대한 변경 내용은 포함되지 않습니다. |
| 구성 요소 기금 모금 행사 나열 |
구성 요소에 대한 모금 행사 할당을 나열합니다. |
| 구성 요소 기본 이름 형식 만들기 |
구성 요소의 기본 이름 형식을 만듭니다. |
| 구성 요소 기본 이름 형식 업데이트 |
구성 요소의 기본 이름 형식을 업데이트합니다. |
| 구성 요소 나열 |
구성 요소 목록을 반환합니다. |
| 구성 요소 노트 나열 |
구성 요소의 노트를 나열합니다. |
| 구성 요소 노트 만들기 |
새 구성 요소를 만듭니다. |
| 구성 요소 노트 업데이트 |
구성 요소를 업데이트합니다. |
| 구성 요소 동의 레코드 나열 |
구성 요소에 대한 동의 레코드를 나열합니다. |
| 구성 요소 동의 레코드 만들기 |
새 구성 요소 동의 레코드를 만듭니다. |
| 구성 요소 별칭 나열 |
구성 요소의 별칭을 나열합니다. |
| 구성 요소 별칭 만들기 |
새 구성 요소 별칭을 만듭니다. |
| 구성 요소 별칭 업데이트 |
구성 요소 별칭을 업데이트합니다. |
| 구성 요소 사용자 정의 필드 나열 |
구성 요소에 대한 사용자 지정 필드를 나열합니다. |
| 구성 요소 사용자 정의 필드 만들기 |
새 구성 요소 사용자 정의 필드를 만듭니다. |
| 구성 요소 사용자 정의 필드 업데이트 |
구성 요소 사용자 정의 필드를 업데이트합니다. |
| 구성 요소 업데이트 |
구성 요소를 업데이트합니다. |
| 구성 요소 온라인 프레즌스 만들기 |
새 구성 요소 온라인 현재 상태를 만듭니다. |
| 구성 요소 온라인 현재 상태 나열 |
구성 요소의 온라인 현재 상태를 나열합니다. |
| 구성 요소 온라인 현재 상태 업데이트 |
구성 요소 온라인 현재 상태를 업데이트합니다. |
| 구성 요소 요청 코드 나열 |
구성 요소에 대한 요청 코드를 나열합니다. |
| 구성 요소 요청 코드 만들기 |
새 구성 요소 요청 코드를 만듭니다. |
| 구성 요소 요청 코드 업데이트 |
구성 요소 요청 코드를 업데이트합니다. |
| 구성 요소 이름 형식 만들기 |
새 구성 요소 이름 형식을 만듭니다. |
| 구성 요소 이름 형식 업데이트 |
구성 요소 이름 형식을 업데이트합니다. |
| 구성 요소 이름 형식 요약 가져오기 |
구성 요소의 이름 형식 요약을 반환합니다. |
| 구성 요소 전자 메일 주소 나열 |
구성 요소의 전자 메일 주소를 나열합니다. |
| 구성 요소 전자 메일 주소 만들기 |
새 구성 전자 메일 주소를 만듭니다. |
| 구성 요소 전자 메일 주소 업데이트 |
구성 요소 전자 메일 주소를 업데이트합니다. |
| 구성 요소 주소 나열 |
구성 요소의 주소를 나열합니다. |
| 구성 요소 주소 만들기 |
새 구성 요소를 만듭니다. |
| 구성 요소 주소 업데이트 |
구성 요소를 업데이트합니다. |
| 구성 요소 첨부 파일 나열 |
구성 요소에 대한 첨부 파일을 나열합니다. |
| 구성 요소 첨부 파일 만들기 |
새 구성 요소 첨부 파일을 만듭니다. |
| 구성 요소 첨부 파일 업데이트 |
구성 요소 첨부 파일을 업데이트합니다. |
| 구성 요소 코드 나열 |
구성 요소의 구성 요소를 나열합니다. |
| 구성 요소 코드 만들기 |
새 구성 요소를 만듭니다. |
| 구성 요소 코드 삭제 |
구성 요소를 삭제합니다. |
| 구성 요소 코드 업데이트 |
구성 요소를 업데이트합니다. |
| 구성 요소 프로필 사진 가져오기 |
구성 요소의 현재 프로필 그림을 반환합니다. |
| 구성 요소 프로필 사진 업데이트 |
구성 요소의 현재 프로필 사진을 업데이트합니다. |
| 구성 요소로 변환 |
구성 요소가 아닌 구성 요소를 변환합니다. |
| 구성 전화 나열 |
구성 요소의 휴대폰을 나열합니다. |
| 구성 전화 만들기 |
새 구성 전화기를 만듭니다. |
| 구성 전화 업데이트 |
구성 전화기를 업데이트합니다. |
| 구성원 자격 나열 |
구성 요소의 멤버 자격을 나열합니다. |
| 기금 모금 과제 나열 |
기금 모금 행사의 과제를 나열합니다. |
| 모금 행사 할당 만들기 |
새 모금 행사 할당을 만듭니다. |
| 목록 공물 승인 |
공물의 승인을 나열합니다. |
| 조직 관계 만들기 |
새 조직 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다. |
| 조직 구성 요소 만들기 |
새 조직 구성 요소를 만듭니다. |
| 조회 ID로 구성 요소 가져오기 |
지정된 조회 ID에서 구성 요소의 시스템 레코드 ID를 반환합니다. |
| 중복 구성 요소 검색 |
개별, 조직 및 관련 연락처 레코드를 검색하고 지정된 검색 필터에 따라 잠재적 중복 항목의 순위를 지정합니다. 여러 필터와 일치하는 레코드는 잠재적 중복 항목으로 순위가 더 높습니다. |
개별 관계 만들기
새 개별 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
관계와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
관계 ID
|
relation_id | True | string |
관련 개인의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
관계가 나타내는 관계의 형식입니다. |
|
|
상호 형식
|
reciprocal_type | string |
관련 구성 요소와 구성 요소의 관계를 설명합니다. 예를 들어, 남성 구성 요소와 여성 형제 간의 관계에서 상호 관계 유형은 형제가 됩니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
배우자인가요?
|
is_spouse | boolean |
관련 개인이 구성 요소의 배우자인가요? |
|
|
가구의 구성 머리인가요?
|
is_constituent_head_of_household | boolean |
구성 요소는 가정의 머리인가? |
|
|
배우자는 가정의 머리인가요?
|
is_spouse_head_of_household | boolean |
배우자가 가정의 머리인가요? |
|
|
비고
|
comment | string |
관계에 대한 추가 정보입니다. |
반환
개별 관계 만들기
개별 구성 요소 만들기
새 개별 구성 요소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
제목
|
title | string |
구성 요소의 기본 제목입니다. |
|
|
이름 (이름의 첫 부분)
|
first | string |
구성 요소의 이름입니다. 문자 제한: 50. |
|
|
성(姓)
|
last | True | string |
구성 요소의 성입니다. 문자 제한: 100. |
|
접미사
|
suffix | string |
구성 요소의 기본 접미사입니다. |
|
|
조회 ID
|
lookup_id | string |
구성 요소에 대한 사용자 정의 식별자입니다. |
|
|
type
|
type | True | string |
주소 유형입니다. |
|
country
|
country | string |
주소의 국가(ID, 이름 또는 약어일 수 있습니다). |
|
|
라인
|
address_lines | string |
주소 줄입니다. 문자 제한: 150. |
|
|
city
|
city | string |
주소의 도시입니다(교외 필드와 함께 사용하지 마세요). |
|
|
주
|
state | string |
주소의 상태입니다. |
|
|
우편번호
|
postal_code | string |
주소의 우편 번호입니다. 문자 제한: 12. |
|
|
교외
|
suburb | string |
주소의 교외(도시 필드와 함께 사용하지 마세요). |
|
|
군
|
county | string |
주소의 카운티입니다. |
|
|
start
|
start | date |
구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18'). |
|
|
끝
|
end | date |
구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다. |
|
|
type
|
type | True | string |
전화 유형입니다. |
|
숫자
|
number | True | string |
전화 번호입니다. |
|
기본인가요?
|
primary | boolean |
이 번호가 구성 요소의 기본 전화 번호인가요? |
|
|
type
|
type | True | string |
전자 메일 주소의 유형입니다. |
|
address
|
address | True | string |
전자 메일 주소입니다. |
|
기본인가요?
|
primary | boolean |
이 주소가 구성 요소의 기본 이메일 주소인가요? |
|
|
type
|
type | True | string |
온라인 현재 상태 유형입니다. |
|
address
|
address | True | string |
온라인 상태의 웹 주소입니다. |
|
기본인가요?
|
primary | boolean |
이것은 구성 요소의 주요 온라인 존재인가요? |
|
|
기본 설정 이름
|
preferred_name | string |
구성 요소의 기본 설정 이름입니다. 문자 제한: 50. |
|
|
중간 이름
|
middle | string |
구성 요소의 중간 이름입니다. 문자 제한: 50. |
|
|
이전 이름
|
former_name | string |
구성 요소의 이전 이름입니다. 문자 제한: 100. |
|
|
제목 2
|
title_2 | string |
구성 요소의 보조 제목입니다. |
|
|
접미사 2
|
suffix_2 | string |
구성 요소의 보조 접미사입니다. |
|
|
성별
|
gender | string |
구성 요소의 성별입니다. |
|
|
결혼 상태
|
marital_status | string |
구성 요소의 결혼 상태. |
|
|
익명으로 제공?
|
gives_anonymously | boolean |
구성 요소는 익명으로 제공합니까? |
|
|
전자 메일을 요청하지 않습니다.
|
requests_no_email | boolean |
구성 요소가 전자 메일을 요청하지 않나요? |
|
|
변호사가 있습니까?
|
is_solicitor | boolean |
구성 요소는 변호사인가요? |
|
|
유효한 주소가 없나요?
|
no_valid_address | boolean |
구성 요소에 유효한 주소가 없나요? |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
출생지
|
birthplace | string |
구성 요소의 발상지입니다. |
|
|
민족성
|
ethnicity | string |
구성 요소의 민족성입니다. |
|
|
목표/타겟
|
target | string |
구성 요소의 대상입니다. |
|
|
소득
|
income | string |
구성 요소의 소득입니다. |
|
|
영수증 유형
|
receipt_type | string |
구성 요소의 영수증 유형입니다. |
|
|
종교
|
religion | string |
구성 요소의 종교. |
|
|
사용자 지정 주소
|
custom_format | boolean |
주 주소가 사용자 지정 형식인가요? |
|
|
주소 형식
|
configuration_id | string |
기본 주소 구성(사용자 지정 형식을 사용하지 않는 한 필요). |
|
|
주소 지정 이름
|
formatted_name | string |
기본 주소 형식 이름(사용자 지정 형식을 사용하는 경우 필요)입니다. 문자 제한: 255. |
|
|
사용자 지정 인사말?
|
custom_format | boolean |
기본 인사말이 사용자 지정 형식인가요? |
|
|
인사말 형식
|
configuration_id | string |
기본 인사말 구성(사용자 지정 형식을 사용하지 않는 한 필요). |
|
|
인사말 사용자 지정 이름
|
formatted_name | string |
기본 인사말 서식이 지정된 이름(사용자 지정 형식을 사용하는 경우 필요)입니다. 문자 제한: 255. |
|
|
기념관인가요?
|
is_memorial | boolean |
구성 요소는 명예 / 기념인가? |
반환
개별 구성 요소 만들기
공물 승인 만들기
새 공물 승인을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
공물 ID
|
tribute_id | True | integer |
승인과 연결된 공물의 시스템 레코드 ID입니다. |
|
관계 ID
|
relationship_id | integer |
관계의 시스템 레코드 ID입니다(null인 경우 자체 승인을 나타낸다). |
|
|
문자 ID
|
letter_id | integer |
문자 ID입니다. |
반환
만든 공물 승인
구성 교육 만들기
새 구성 교육을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
교육과 관련된 구성 요소의 시스템 레코드 ID입니다. |
|
학교
|
school | True | string |
학교/설립 이름입니다. |
|
유형
|
type | string |
교육 유형입니다. |
|
|
의 클래스
|
class_of | string |
구성 요소가 졸업한 해입니다. |
|
|
상태
|
status | string |
교육의 상태입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
정도
|
degree | string |
받은 학위입니다. |
|
|
GPA
|
gpa | double |
성적 포인트 평균입니다. |
|
|
연구 대상
|
subject_of_study | string |
연구의 주제입니다. |
|
|
본래의?
|
primary | boolean |
이것이 선거구의 초등학교 협회인가요? |
|
|
전공
|
majors | array of string |
연구의 주요 과정. |
|
|
미성년자
|
minors | array of string |
연구의 사소한 과정. |
|
|
Campus
|
campus | string |
캠퍼스. 문자 제한: 50. |
|
|
소셜 조직
|
social_organization | string |
사회 조직. 문자 제한: 50. |
|
|
알려진 이름
|
known_name | string |
알려진 이름입니다. 문자 제한: 50. |
|
|
학위의 클래스
|
class_of_degree | string |
학위 클래스(영국 버전에만 해당)입니다. |
|
|
부서
|
department | string |
교육 부서의 이름입니다(영국 버전에만 적용됨). |
|
|
학부
|
faculty | string |
교직원의 이름입니다(영국 버전에만 적용됨). |
|
|
등록 번호
|
registration_number | string |
등록 번호(영국 버전에만 해당)입니다. 문자 제한: 50. |
반환
구성 교육 만들기
구성 교육 목록
구성 요소에 대한 교육 레코드를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
교육
구성 교육 업데이트
구성 교육을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
교육 ID
|
education_id | True | string |
업데이트할 교육 레코드의 시스템 레코드 ID입니다. |
|
학교
|
school | string |
학교/설립 이름입니다. |
|
|
유형
|
type | string |
교육 유형입니다. |
|
|
의 클래스
|
class_of | string |
구성 요소가 졸업한 해입니다. |
|
|
상태
|
status | string |
교육의 상태입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
정도
|
degree | string |
받은 학위입니다. |
|
|
GPA
|
gpa | double |
성적 포인트 평균입니다. |
|
|
연구 대상
|
subject_of_study | string |
연구의 주제입니다. |
|
|
본래의?
|
primary | boolean |
이것이 선거구의 초등학교 협회인가요? |
|
|
전공
|
majors | array of string |
연구의 주요 과정. |
|
|
미성년자
|
minors | array of string |
연구의 사소한 과정. |
|
|
Campus
|
campus | string |
캠퍼스. 문자 제한: 50. |
|
|
소셜 조직
|
social_organization | string |
사회 조직. 문자 제한: 50. |
|
|
알려진 이름
|
known_name | string |
알려진 이름입니다. 문자 제한: 50. |
|
|
학위의 클래스
|
class_of_degree | string |
학위의 클래스입니다. |
|
|
부서
|
department | string |
교육 부서의 이름입니다. |
|
|
학부
|
faculty | string |
교직원의 이름입니다. |
|
|
등록 번호
|
registration_number | string |
등록 번호입니다. 문자 제한: 50. |
구성 요소 가져오기
구성 요소에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
가져올 구성 요소의 시스템 레코드 ID입니다. |
반환
성분
구성 요소 검색
제공된 검색 텍스트를 기반으로 구성 요소 검색을 수행합니다. 이름, 성, 기본 설정 이름, 이전 이름, 별칭, 전자 메일 주소, 전화 번호, 주소 또는 조회 ID를 지원합니다. 이름, 성, 기본 이름 및 성 등의 이름 조합은 유효하지만, 그렇지 않으면 검색에서 한 번에 하나의 매개 변수만 지원합니다. 기본적으로 검색에는 조건과 비슷한 결과가 포함됩니다. 예를 들어 "Smith"에 대한 검색에는 "Smyth" 및 기타 대체 맞춤법의 일치 항목이 포함됩니다. 이 검색은 * 또는 ?와 같은 와일드카드 문자를 지원하지 않습니다. 검색 결과는 500개 레코드로 제한됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
텍스트 검색
|
search_text | True | string |
검색 텍스트입니다. 이름, 성, 기본 설정 이름, 이전 이름, 별칭, 전자 메일 주소, 전화 번호, 주소 또는 조회 ID를 지원합니다. 이름, 성, 기본 이름 및 성 등의 이름 조합은 유효하지만, 그렇지 않으면 검색에서 한 번에 하나의 매개 변수만 지원합니다. 기본적으로 검색에는 조건과 비슷한 결과가 포함됩니다. 예를 들어 "Smith"에 대한 검색에는 "Smyth" 및 기타 대체 맞춤법의 일치 항목이 포함됩니다. 이 검색은 * 또는 ?와 같은 와일드카드 문자를 지원하지 않습니다. 검색 결과는 500개 레코드로 제한됩니다. |
|
모금 행사 상태
|
fundraiser_status | string |
결과를 필터링하기 위해 쉼표로 구분된 기금 모금 상태 목록을 나타냅니다. 예를 들어 "Active,None"은 기금 모금 상태가 활성 또는 없음인 구성 요소만 반환합니다. 이 필터의 유효한 값은 활성, 비활성 및 없음입니다. |
|
|
비활성 상태 포함
|
include_inactive | boolean |
응답에 비활성 구성 요소를 포함하시겠습니까? |
|
|
검색 필드
|
search_field | string |
검색할 필드를 나타냅니다. 현재는 lookup_id 지원합니다. search_text 제공된 경우 search_text 일치하는 lookup_id 있는 구성 요소가 반환됩니다. |
|
|
엄격한 검색을 사용하시겠습니까?
|
strict_search | boolean |
이름이 검색 텍스트처럼 들리지만 철자가 다른 구성 요소를 제외하시겠습니까? |
|
|
한계
|
limit | integer |
반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다. |
|
|
상쇄
|
offset | integer |
건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. |
반환
검색 결과
구성 요소 검색(향상된)
지정된 필터 조건을 사용하여 구성 레코드를 검색합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름 (이름의 첫 부분)
|
first_name | string |
구성 요소 이름입니다. |
|
|
성(姓)
|
last_name | string |
구성 요소 성입니다. |
|
|
조회 ID
|
lookup_id | string |
구성 요소 조회 ID입니다. |
|
|
전자 메일 주소
|
string |
구성 요소 전자 메일 주소입니다. |
||
|
전화번호
|
phone_number | string |
전화번호. |
|
|
한계
|
limit | integer |
반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 1000입니다. |
|
|
주소 줄
|
address_lines | string |
주소 줄입니다. |
|
|
도시
|
city | string |
주소 도시입니다. |
|
|
주
|
state | string |
주소 상태입니다. |
|
|
우편번호
|
post_code | string |
주소 우편 번호입니다. |
|
|
별칭을 포함하시겠습니까?
|
include_alias | boolean |
성을 검색할 때 별칭을 포함하시겠습니까? |
|
|
별칭 형식
|
alias_type | string |
별칭 형식입니다. |
|
|
처녀 이름을 포함?
|
include_maiden_name | boolean |
성을 검색할 때 처녀 이름을 포함하시겠습니까? |
반환
성분
구성 요소 공물 가져오기
구성 요소 공물의 세부 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
공물 ID
|
tribute_id | True | string |
공물 ID입니다. |
반환
공물
구성 요소 공물 나열
구성 요소에 대한 공물을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituentId | True | integer |
구성 요소의 시스템 레코드 ID입니다. |
반환
공 물
구성 요소 공물 만들기
새 구성 요소 공물을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_record_id | True | integer |
공물과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
헌정 유형
|
tribute_type_id | True | integer |
헌정 형식입니다. |
|
Description
|
description | string |
공물 설명입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
기본 펀드 ID
|
default_fund_id | integer |
공물과 연결된 기본 펀드의 시스템 레코드 ID입니다. |
|
|
비고
|
notes | string |
공물 노트. |
|
|
활동적인?
|
is_active | boolean |
이 공물은 활성화되어 있습니까? |
반환
만든 구성 요소 공물
구성 요소 관계 나열
구성 요소의 관계를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
한계
|
limit | integer |
반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 없습니다. |
|
|
상쇄
|
offset | integer |
건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. |
반환
관계
구성 요소 관계 업데이트
구성 요소에 대한 관계를 업데이트합니다. 상호 관계가 있는 경우 변경 내용을 반영하도록 수정됩니다. 여기에는 각 레코드와 관련이 있으며 각 레코드에서 독립적으로 수정할 수 있는 "comments" 속성에 대한 변경 내용은 포함되지 않습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
관계 ID
|
relationship_id | True | string |
업데이트할 관계의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
관계가 나타내는 관계의 형식입니다. |
|
|
상호 형식
|
reciprocal_type | string |
관련 구성 요소와 구성 요소의 관계를 설명합니다. 예를 들어, 남성 구성 요소와 여성 형제 간의 관계에서 상호 관계 유형은 형제가 됩니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
배우자인가요?
|
is_spouse | boolean |
관련 개인이 구성 요소의 배우자인가요(개인 간의 관계에만 적용됨)? |
|
|
가구의 구성 머리인가요?
|
is_constituent_head_of_household | boolean |
구성 요소는 가정의 머리인가? |
|
|
배우자는 가정의 머리인가요?
|
is_spouse_head_of_household | boolean |
배우자가 가정의 머리인가요? |
|
|
비고
|
comment | string |
관계에 대한 추가 정보입니다. |
|
|
연락처인가요?
|
is_organization_contact | boolean |
구성 요소가 이 조직을 연락처로 나타내나요(조직과 개인 간의 관계에만 적용됨)? |
|
|
기본 비즈니스인가요?
|
is_primary_business | boolean |
구성 요소의 기본 비즈니스인가요(조직과 개인 간의 관계에만 적용됨)? |
|
|
연락처 유형
|
organization_contact_type | string |
조직을 연락처로 나타내는 관련 개인과의 상호 작용에 대한 컨텍스트를 제공합니다. 조직과 개인 간의 관계에만 적용됩니다. |
|
|
Position
|
position | string |
조직에서 개인의 위치입니다. 조직과 개인 간의 관계에만 적용됩니다. 문자 제한: 50. |
구성 요소 기금 모금 행사 나열
구성 요소에 대한 모금 행사 할당을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
비활성 상태 포함
|
include_inactive | boolean |
비활성 기금 모금 행사를 포함하시겠습니까? |
반환
기금 모금 과제
구성 요소 기본 이름 형식 만들기
구성 요소의 기본 이름 형식을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
primary_type | True | string |
기본 이름 형식 형식입니다. |
|
사용자 지정 이름 형식
|
custom_format | boolean |
사용자 지정 형식인가요? |
|
|
포맷
|
configuration_id | string |
이름 형식 구성(사용자 지정 형식을 사용하지 않는 한 필요). |
|
|
사용자 지정 이름
|
formatted_name | string |
서식이 지정된 이름(사용자 지정 형식을 사용하는 경우 필요). 문자 제한: 255. |
반환
만든 이름 형식
구성 요소 기본 이름 형식 업데이트
구성 요소의 기본 이름 형식을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름 형식 ID
|
primary_name_format_id | True | string |
업데이트할 기본 이름 형식의 시스템 레코드 ID입니다. |
|
사용자 지정 이름 형식
|
custom_format | boolean |
사용자 지정 형식인가요? |
|
|
포맷
|
configuration_id | string |
이름 형식 구성(사용자 지정 형식을 사용하지 않는 한 필요). |
|
|
사용자 지정 이름
|
formatted_name | string |
서식이 지정된 이름(사용자 지정 형식을 사용하는 경우 필요). 문자 제한: 255. |
구성 요소 나열
구성 요소 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
List
|
list_id | string |
지정된 목록에 포함된 구성 요소 집합을 필터링하는 데 사용되는 목록 식별자를 정의합니다. 이 값을 설정하면 지정된 다른 필터가 무시됩니다. |
|
|
한계
|
limit | integer |
반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다. |
|
|
상쇄
|
offset | integer |
건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. |
|
|
구성 코드
|
constituent_code | string |
목록을 필터링할 구성 요소를 나타냅니다. 예를 들어 "이사회 구성원"은 이사회 구성원 구성 코드가 있는 구성 요소만 반환합니다. |
|
|
구성 요소 ID
|
constituent_id | string |
결과를 필터링할 구성 요소 시스템 레코드 ID의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "280,1232"는 구성 요소 280 또는 구성 요소 1232만 반환합니다. |
|
|
사용자 지정 필드 범주
|
custom_field_category | string |
결과를 필터링할 사용자 지정 필드 범주를 나타냅니다. 예를 들어 "Anniversary"는 활성 1주년 사용자 정의 필드가 있는 구성 요소만 반환합니다. |
|
|
모금 행사 상태
|
fundraiser_status | string |
결과를 필터링하기 위해 쉼표로 구분된 기금 모금 상태 목록을 나타냅니다. 예를 들어 "Active,None"은 기금 모금 상태가 활성 또는 없음인 구성 요소만 반환합니다. 이 필터의 유효한 값은 활성, 비활성 및 없음입니다. |
|
|
고인을 포함하시겠습니까?
|
include_deceased | boolean |
응답에 사망 한 성분을 포함? |
|
|
비활성 상태 포함
|
include_inactive | boolean |
응답에 비활성 구성 요소를 포함하시겠습니까? |
|
|
우편번호
|
postal_code | string |
결과를 필터링할 우편 번호의 쉼표로 구분된 목록을 나타냅니다. 예를 들어 "29466,29492"는 기본 주소에 29466 또는 29492로 시작하는 우편 번호(예: 29466, 29492 또는 29492-0727)가 있는 구성 요소만 반환합니다. |
|
|
추가된 이후
|
date_added | date-time |
지정된 날짜(예: '2020-09-18T04:13:56Z')에서 만든 구성 요소로 결과를 필터링합니다. |
|
|
수정된 날짜 또는 이후
|
last_modified | date-time |
지정된 날짜(예: '2020-09-18T04:13:56Z')에서 수정된 구성 요소로 결과를 필터링합니다. |
|
|
정렬 기준
|
sort | string |
결과를 정렬할 필드 목록을 나타냅니다. 결과는 기본적으로 오름차순이며 '-' 기호는 내림차순을 표시합니다. 예를 들어 "date_added,-last"는 "date_added" 필드를 기준으로 구성 요소를 오름차순으로 정렬한 다음 " 마지막" 필드를 내림차순으로 정렬합니다. |
반환
성분
구성 요소 노트 나열
구성 요소의 노트를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
비고
구성 요소 노트 만들기
새 구성 요소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
메모와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | True | string |
메모 유형입니다. |
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
요약
|
summary | string |
메모 요약입니다. 문자 제한: 50. |
|
|
비고
|
text | string |
메모 텍스트입니다. |
|
|
작성자
|
author | string |
메모 작성자입니다. 제공되지 않으면 사용자의 계정에 따라 기본 집합이 설정됩니다. 문자 제한: 50. |
반환
만든 구성 요소 노트
구성 요소 노트 업데이트
구성 요소를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
참고 ID
|
note_id | True | string |
업데이트할 메모의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
메모 유형입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
요약
|
summary | string |
메모 요약입니다. 문자 제한: 50. |
|
|
비고
|
text | string |
메모 텍스트입니다. |
구성 요소 동의 레코드 나열
구성 요소에 대한 동의 레코드를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
가장 최근만?
|
most_recent_only | boolean |
응답에 각 채널 범주 조합에 대한 최신 동의 레코드만 포함하시겠습니까? |
반환
동의 레코드
구성 요소 동의 레코드 만들기
새 구성 요소 동의 레코드를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
동의 레코드와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
채널
|
channel | True | string |
동의 응답이 적용되는 채널입니다. |
|
카테고리
|
category | string |
동의 응답이 적용되는 범주입니다. |
|
|
출처
|
source | string |
구성 요소의 동의 응답 원본입니다. |
|
|
응답
|
constituent_consent_response | True | string |
구성 요소가 지정된 채널/범주에 대한 동의에 응답하는 방식입니다. |
|
날짜
|
consent_date | True | date-time |
동의 응답을 받은 날짜(예: '2020-09-18T04:13:56Z'). |
|
동의 문
|
consent_statement | string |
동의를 제공할 때 구성 요소가 응답한 진술입니다. |
|
|
개인정보 처리방침
|
privacy_notice | string |
구성 요소에 제공된 개인 정보 보호 알림입니다. |
반환
구성 요소 동의 생성
구성 요소 별칭 나열
구성 요소의 별칭을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
Aliases
구성 요소 별칭 만들기
새 구성 요소 별칭을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
별칭과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
Alias
|
name | True | string |
구성 요소의 별칭으로 사용할 이름입니다. 문자 제한: 100. |
|
유형
|
type | string |
별칭 형식입니다. |
반환
만든 구성 별칭
구성 요소 별칭 업데이트
구성 요소 별칭을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
별칭 ID
|
alias_id | True | string |
업데이트할 별칭의 시스템 레코드 ID입니다. |
|
Alias
|
name | string |
구성 요소의 별칭으로 사용할 이름입니다. 문자 제한: 100. |
|
|
유형
|
type | string |
별칭 형식입니다. |
구성 요소 사용자 정의 필드 나열
구성 요소에 대한 사용자 지정 필드를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
사용자 지정 필드
구성 요소 사용자 정의 필드 만들기
새 구성 요소 사용자 정의 필드를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
body
|
body | True | dynamic |
만들 사용자 지정 필드를 나타내는 개체입니다. |
반환
만든 구성 요소 사용자 정의 필드
구성 요소 사용자 정의 필드 업데이트
구성 요소 사용자 정의 필드를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
사용자 지정 필드 ID
|
custom_field_id | True | string |
업데이트할 사용자 지정 필드의 시스템 레코드 ID입니다. |
|
body
|
body | True | dynamic |
업데이트할 사용자 지정 필드의 속성을 나타내는 개체입니다. |
구성 요소 업데이트
구성 요소를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
업데이트할 구성 요소의 시스템 레코드 ID입니다. |
|
제목
|
title | string |
구성 요소의 기본 제목입니다(개인만 해당). |
|
|
이름 (이름의 첫 부분)
|
first | string |
구성 요소의 이름입니다(개인만 해당). 문자 제한: 50. |
|
|
성(姓)
|
last | string |
구성 요소의 성(개인만 해당)입니다. 문자 제한: 100. |
|
|
조직 이름
|
name | string |
개인의 경우 편집 작업에는 적용되지 않는 계산 필드입니다. 조직의 경우 이 필드는 필수이며 조직의 이름을 나타냅니다. 문자 제한: 100. |
|
|
접미사
|
suffix | string |
구성 요소의 기본 접미사입니다(개인만 해당). |
|
|
기본 설정 이름
|
preferred_name | string |
구성 요소의 기본 설정 이름입니다(개인만 해당). 문자 제한: 50. |
|
|
조회 ID
|
lookup_id | string |
구성 요소에 대한 사용자 정의 식별자입니다. |
|
|
성별
|
gender | string |
구성 요소의 성별(개인만 해당). |
|
|
중간 이름
|
middle | string |
구성 요소의 중간 이름입니다(개인만 해당). 문자 제한: 50. |
|
|
이전 이름
|
former_name | string |
구성 요소의 이전 이름입니다(개인만 해당). 문자 제한: 100. |
|
|
제목 2
|
title_2 | string |
구성 요소의 보조 제목입니다(개인만 해당). |
|
|
접미사 2
|
suffix_2 | string |
구성 요소의 보조 접미사입니다(개인만 해당). |
|
|
결혼 상태
|
marital_status | string |
구성 요소의 결혼 상태(개인만 해당). |
|
|
익명으로 제공?
|
gives_anonymously | boolean |
구성 요소는 익명으로 제공합니까? |
|
|
전자 메일을 요청하지 않습니다.
|
requests_no_email | boolean |
구성 요소가 전자 메일을 요청하지 않나요? |
|
|
변호사가 있습니까?
|
is_solicitor | boolean |
구성 요소는 변호사인가요? |
|
|
유효한 주소가 없나요?
|
no_valid_address | boolean |
구성 요소에 유효한 주소가 없나요? |
|
|
게으른?
|
inactive | boolean |
구성 요소가 비활성 상태인가요? |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
출생지
|
birthplace | string |
구성 요소의 발상지입니다(개인만 해당). |
|
|
민족성
|
ethnicity | string |
구성 요소의 민족성(개인만 해당). |
|
|
목표/타겟
|
target | string |
구성 요소의 대상입니다. |
|
|
소득
|
income | string |
구성 요소의 소득입니다(개인만 해당). |
|
|
영수증 유형
|
receipt_type | string |
구성 요소의 영수증 유형입니다. |
|
|
종교
|
religion | string |
구성 요소의 종교(개인만 해당). |
|
|
산업
|
industry | string |
구성 요소의 산업(조직에만 해당). |
|
|
직원 수
|
num_employees | integer |
조직의 직원 수입니다. |
|
|
선물과 일치하시겠습니까?
|
matches_gifts | boolean |
조직이 선물과 일치하나요? |
|
|
일치하는 기프트 팩터
|
matching_gift_factor | double |
일치하는 기프트 팩터(조직에만 해당)입니다. |
|
|
선물당 최소 일치
|
value | double |
구성 요소에 대한 선물당 최소 일치 금액입니다(조직에만 해당). |
|
|
선물당 최대 일치 항목
|
value | double |
구성 요소에 대한 선물당 최대 일치 금액입니다(조직에만 해당). |
|
|
constit당 최소 일치 항목
|
value | double |
구성 요소의 최소 일치 합계입니다(조직에만 해당). |
|
|
constit당 최대 일치 항목
|
value | double |
구성 요소의 최대 일치 합계입니다(조직에만 해당). |
|
|
일치하는 기프트 노트
|
matching_gift_notes | string |
구성 요소에 대한 일치하는 기프트 노트입니다(조직에만 해당). |
|
|
고?
|
deceased | boolean |
구성 요소가 사망합니까 (개인만 해당)? |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
기념관인가요?
|
is_memorial | boolean |
구성 요소는 명예 / 기념인가? |
구성 요소 온라인 프레즌스 만들기
새 구성 요소 온라인 현재 상태를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
온라인 상태와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | True | string |
온라인 현재 상태 유형입니다. |
|
Link
|
address | True | string |
온라인 상태의 웹 주소입니다. |
|
본래의?
|
primary | boolean |
이것은 구성 요소의 주요 온라인 존재인가요? |
|
|
게으른?
|
inactive | boolean |
이 온라인 프레즌스는 비활성 상태인가요? |
반환
구성 요소 온라인 프레즌스 만들기
구성 요소 온라인 현재 상태 나열
구성 요소의 온라인 현재 상태를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
비활성 상태 포함
|
include_inactive | boolean |
비활성 온라인 프레즌스를 포함하시겠습니까? |
반환
온라인 상태
구성 요소 온라인 현재 상태 업데이트
구성 요소 온라인 현재 상태를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
온라인 현재 상태 ID
|
online_presence_id | True | string |
업데이트할 온라인 상태의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
온라인 현재 상태 유형입니다. |
|
|
Link
|
address | string |
온라인 상태의 웹 주소입니다. |
|
|
본래의?
|
primary | boolean |
이것은 구성 요소의 주요 온라인 존재인가요? |
|
|
게으른?
|
inactive | boolean |
이 온라인 프레즌스는 비활성 상태인가요? |
구성 요소 요청 코드 나열
구성 요소에 대한 요청 코드를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
코드 요청
구성 요소 요청 코드 만들기
새 구성 요소 요청 코드를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
요청 코드와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
코드 요청
|
solicit_code | True | string |
구성 요소에 대한 통신 지침 및/또는 제한 사항입니다. |
|
시작 날짜
|
start_date | date |
요청 코드의 시작 날짜입니다(예: '2005-09-18'). |
|
|
끝 날짜
|
end_date | date |
요청 코드의 종료 날짜입니다(예: '2005-09-18'). |
반환
구성 요소 요청 코드 만들기
구성 요소 요청 코드 업데이트
구성 요소 요청 코드를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
코드 ID 요청
|
constituent_solicit_code_id | True | string |
업데이트할 요청 코드의 시스템 레코드 ID입니다. |
|
코드 요청
|
solicit_code | string |
구성 요소에 대한 통신 지침 및/또는 제한 사항입니다. |
|
|
시작 날짜
|
start_date | date |
요청 코드의 시작 날짜입니다(예: '2005-09-18'). |
|
|
끝 날짜
|
end_date | date |
요청 코드의 종료 날짜입니다(예: '2005-09-18'). |
구성 요소 이름 형식 만들기
새 구성 요소 이름 형식을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | True | string |
이름 형식 형식입니다. |
|
사용자 지정 이름 형식
|
custom_format | boolean |
사용자 지정 형식인가요? |
|
|
포맷
|
configuration_id | string |
이름 형식 구성(사용자 지정 형식을 사용하지 않는 한 필요). |
|
|
사용자 지정 이름
|
formatted_name | string |
서식이 지정된 이름(사용자 지정 형식을 사용하는 경우 필요). 문자 제한: 255. |
반환
만든 이름 형식
구성 요소 이름 형식 업데이트
구성 요소 이름 형식을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름 형식 ID
|
name_format_id | True | string |
업데이트할 이름 형식의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
이름 형식 형식입니다. |
|
|
사용자 지정 이름 형식
|
custom_format | boolean |
사용자 지정 형식인가요? |
|
|
포맷
|
configuration_id | string |
이름 형식 구성(사용자 지정 형식을 사용하지 않는 한 필요). |
|
|
사용자 지정 이름
|
formatted_name | string |
서식이 지정된 이름(사용자 지정 형식을 사용하는 경우 필요). 문자 제한: 255. |
구성 요소 이름 형식 요약 가져오기
구성 요소의 이름 형식 요약을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
이름 형식 요약
구성 요소 전자 메일 주소 나열
구성 요소의 전자 메일 주소를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
비활성 상태 포함
|
include_inactive | boolean |
비활성 전자 메일 주소를 포함하시겠습니까? |
반환
이메일 주소
구성 요소 전자 메일 주소 만들기
새 구성 전자 메일 주소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
전자 메일 주소와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
전자 메일 유형
|
type | True | string |
전자 메일 주소의 유형입니다. |
|
전자 메일 주소
|
address | True | string |
전자 메일 주소입니다. |
|
본래의?
|
primary | boolean |
이 주소가 구성 요소의 기본 이메일 주소인가요? |
|
|
전자 메일을 보내지 않나요?
|
do_not_email | boolean |
이 전자 메일 주소에서 구성 요소에 연락할 수 있나요? |
|
|
게으른?
|
inactive | boolean |
이 전자 메일 주소가 비활성 상태인가요? |
반환
만든 구성 전자 메일 주소
구성 요소 전자 메일 주소 업데이트
구성 요소 전자 메일 주소를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
전자 메일 주소 ID
|
email_address_id | True | string |
업데이트할 전자 메일 주소의 시스템 레코드 ID입니다. |
|
전자 메일 유형
|
type | string |
전자 메일 주소의 유형입니다. |
|
|
전자 메일 주소
|
address | string |
전자 메일 주소입니다. |
|
|
본래의?
|
primary | boolean |
이 주소가 구성 요소의 기본 이메일 주소인가요? |
|
|
전자 메일을 보내지 않나요?
|
do_not_email | boolean |
이 전자 메일 주소에서 구성 요소에 연락할 수 있나요? |
|
|
게으른?
|
inactive | boolean |
이 전자 메일 주소가 비활성 상태인가요? |
구성 요소 주소 나열
구성 요소의 주소를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
비활성 상태 포함
|
include_inactive | boolean |
비활성 주소를 포함하시겠습니까? |
반환
Addresses
구성 요소 주소 만들기
새 구성 요소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
주소와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
주소 형식
|
type | True | string |
주소 유형입니다. |
|
국가
|
country | string |
주소의 국가(ID, 이름 또는 약어일 수 있습니다). |
|
|
주소 줄
|
address_lines | string |
주소 줄입니다. |
|
|
도시
|
city | string |
주소의 도시입니다(교외 필드와 함께 사용하지 마세요). |
|
|
주
|
state | string |
주소의 상태입니다. |
|
|
우편번호
|
postal_code | string |
주소의 우편 번호입니다. |
|
|
교외
|
suburb | string |
주소의 교외(도시 필드와 함께 사용하지 마세요). |
|
|
군
|
county | string |
주소의 카운티입니다. |
|
|
정보 원본
|
information_source | string |
주소의 정보 원본입니다. |
|
|
지역
|
region | string |
주소의 지역입니다. |
|
|
카트
|
cart | string |
주소에 대한 CART(이동 통신 사업자 경로)입니다. |
|
|
많이
|
lot | string |
주소의 이동 줄(LOT)입니다. |
|
|
DPC
|
dpc | string |
주소의 DPC(배달 지점 코드)입니다. |
|
|
다음에서 유효합니다.
|
start | date |
구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18'). |
|
|
유효한 경우
|
end | date |
구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다. |
|
|
본래의?
|
preferred | boolean |
이 주소가 구성 요소의 기본 주소인가요? |
|
|
메일을 사용하지 않나요?
|
do_not_mail | boolean |
이 주소에서 구성 요소에 연락할 수 있나요? |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
반환
만든 구성 요소 주소
구성 요소 주소 업데이트
구성 요소를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
주소 ID
|
address_id | True | string |
업데이트할 주소의 시스템 레코드 ID입니다. |
|
주소 형식
|
type | string |
주소 유형입니다. |
|
|
국가
|
country | string |
주소의 국가(ID, 이름 또는 약어일 수 있습니다). |
|
|
주소 줄
|
address_lines | string |
주소 줄입니다. |
|
|
도시
|
city | string |
주소의 도시입니다(교외 필드와 함께 사용하지 마세요). |
|
|
주
|
state | string |
주소의 상태입니다. |
|
|
우편번호
|
postal_code | string |
주소의 우편 번호입니다. |
|
|
교외
|
suburb | string |
주소의 교외(도시 필드와 함께 사용하지 마세요). |
|
|
군
|
county | string |
주소의 카운티입니다. |
|
|
정보 원본
|
information_source | string |
주소의 정보 원본입니다. |
|
|
지역
|
region | string |
주소의 지역입니다. |
|
|
카트
|
cart | string |
주소에 대한 CART(이동 통신 사업자 경로)입니다. |
|
|
많이
|
lot | string |
주소의 이동 줄(LOT)입니다. |
|
|
DPC
|
dpc | string |
주소의 DPC(배달 지점 코드)입니다. |
|
|
다음에서 유효합니다.
|
start | date |
구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18'). |
|
|
유효한 경우
|
end | date |
구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다. |
|
|
본래의?
|
preferred | boolean |
이 주소가 구성 요소의 기본 주소인가요? |
|
|
메일을 사용하지 않나요?
|
do_not_mail | boolean |
이 주소에서 구성 요소에 연락할 수 있나요? |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
구성 요소 첨부 파일 나열
구성 요소에 대한 첨부 파일을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
Attachments
구성 요소 첨부 파일 만들기
새 구성 요소 첨부 파일을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
parent_id | True | string |
첨부 파일과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | True | string |
첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다. |
|
이름
|
name | string |
첨부 파일의 이름입니다. 문자 제한: 150. |
|
|
날짜
|
date | date-time |
첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') 이 필드는 기본적으로 현재 날짜 및 시간(제공되지 않은 경우)으로 설정됩니다. |
|
|
URL
|
url | string |
첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다. |
|
|
파일 이름
|
file_name | string |
파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다. |
|
|
파일 ID
|
file_id | string |
파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다. |
|
|
썸네일 ID
|
thumbnail_id | string |
썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다. |
|
|
태그들
|
tags | array of string |
첨부 파일과 연결된 태그입니다. |
반환
구성 요소 첨부 파일 만들기
구성 요소 첨부 파일 업데이트
구성 요소 첨부 파일을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
첨부 파일 ID
|
attachment_id | True | string |
업데이트할 첨부 파일의 시스템 레코드 ID입니다. |
|
이름
|
name | string |
첨부 파일의 이름입니다. 문자 제한: 150. |
|
|
날짜
|
date | date-time |
첨부 파일의 날짜(예: '2020-09-18T04:13:56Z') |
|
|
URL
|
url | string |
첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다. |
|
|
태그들
|
tags | array of string |
첨부 파일과 연결된 태그입니다. |
구성 요소 코드 나열
구성 요소의 구성 요소를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
구성 요소 코드
구성 요소 코드 만들기
새 구성 요소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소 코드와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
구성 코드
|
description | True | string |
구성 요소 코드입니다. |
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
순서
|
sequence | integer |
구성 요소 코드와 연결된 숫자 시퀀스입니다. |
반환
구성 요소 코드 만들기
구성 요소 코드 삭제
구성 요소를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 코드 ID
|
constituent_code_id | True | string |
삭제할 구성 요소 코드의 시스템 레코드 ID입니다. |
구성 요소 코드 업데이트
구성 요소를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 코드 ID
|
constituent_code_id | True | string |
업데이트할 구성 요소 코드의 시스템 레코드 ID입니다. |
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
순서
|
sequence | integer |
구성 요소 코드와 연결된 숫자 시퀀스입니다. |
구성 요소 프로필 사진 가져오기
구성 요소의 현재 프로필 그림을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
프로필 사진을 검색할 구성 요소의 시스템 레코드 ID입니다. |
반환
프로필 사진
구성 요소 프로필 사진 업데이트
구성 요소의 현재 프로필 사진을 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
프로필 사진을 업데이트할 구성 요소의 시스템 레코드 ID입니다. |
|
파일 이름
|
file_name | True | string |
파일 이름입니다. |
|
문서 ID
|
document_id | True | uuid |
문서 식별자입니다. |
|
썸네일 ID
|
thumbnail_id | True | uuid |
썸네일 문서 식별자입니다. |
구성 요소로 변환
구성 요소가 아닌 구성 요소를 변환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소가 아닌 ID
|
non_constituent_id | True | string |
변환할 구성 요소가 아닌 레코드의 시스템 레코드 ID입니다. |
|
아이디
|
id | string |
구성 코드의 시스템 레코드 ID입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
식별
|
sequence | integer |
구성 요소 코드의 시퀀스입니다. |
반환
변환된 구성 요소
구성 전화 나열
구성 요소의 휴대폰을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
|
비활성 상태 포함
|
include_inactive | boolean |
비활성 휴대폰을 포함하시겠습니까? |
반환
전화
구성 전화 만들기
새 구성 전화기를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
휴대폰과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | True | string |
전화 유형입니다. |
|
Number
|
number | True | string |
전화 번호입니다. |
|
본래의?
|
primary | boolean |
이것은 구성 요소의 기본 전화인가요? |
|
|
호출하지 않나요?
|
do_not_call | boolean |
이 번호로 구성 요소에 연락할 수 있나요? |
|
|
게으른?
|
inactive | boolean |
이 전화 번호가 비활성 상태인가요? |
반환
만든 구성 전화
구성 전화 업데이트
구성 전화기를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
전화 ID
|
phone_id | True | string |
업데이트할 휴대폰의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
전화 유형입니다. |
|
|
Number
|
number | string |
전화 번호입니다. |
|
|
본래의?
|
primary | boolean |
이것은 구성 요소의 기본 전화인가요? |
|
|
호출하지 않나요?
|
do_not_call | boolean |
이 번호로 구성 요소에 연락할 수 있나요? |
|
|
게으른?
|
inactive | boolean |
이 전화 번호가 비활성 상태인가요? |
구성원 자격 나열
구성 요소의 멤버 자격을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
구성 요소의 시스템 레코드 ID입니다. |
반환
Memberships
기금 모금 과제 나열
기금 모금 행사의 과제를 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
모금 행사 ID
|
fundraiser_id | True | string |
할당을 반환할 기금 모금 행사의 시스템 레코드 ID입니다. |
|
한계
|
limit | integer |
반환할 레코드 수를 나타냅니다. 기본값은 500입니다. 최대값은 5000입니다. |
|
|
상쇄
|
offset | integer |
건너뛸 레코드 수를 나타냅니다. 페이지 매김과 함께 사용합니다. |
반환
Assignments
모금 행사 할당 만들기
새 모금 행사 할당을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
모금 행사 ID
|
fundraiser_id | True | string |
모금 행사의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | True | string |
할당된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
모금 행사의 유형입니다. |
|
|
할당 시작
|
start | date-time |
배정의 시작 날짜(예: '2020-09-18T04:13:56Z') |
|
|
할당 종료
|
end | date-time |
배정 종료 날짜(예: '2020-09-18T04:13:56Z') |
|
|
금액
|
value | True | double |
기금 모금이 할당된 구성원에게 요청할 목표 금액입니다. |
|
캠페인 ID
|
campaign_id | string |
결과 선물을 적용할 캠페인의 시스템 레코드 ID입니다. |
|
|
펀드 ID
|
fund_id | string |
결과 선물을 적용할 펀드의 시스템 레코드 ID입니다. |
|
|
항소 ID
|
appeal_id | string |
결과 선물을 적용할 항소의 시스템 레코드 ID입니다. |
반환
모금 행사 할당 만들기
목록 공물 승인
공물의 승인을 나열합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
공물 ID
|
tributeId | True | integer |
공물의 시스템 레코드 ID입니다. |
반환
공물 인정
조직 관계 만들기
새 조직 관계를 만듭니다. 관계가 다른 구성 요소와 인 경우 해당 구성 요소에 대한 상호 관계가 만들어집니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
구성 요소 ID
|
constituent_id | True | string |
관계와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
관계 ID
|
relation_id | True | string |
관련 조직의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
관계가 나타내는 관계의 형식입니다. |
|
|
상호 형식
|
reciprocal_type | string |
관련 조직과의 관계를 설명합니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
일
|
d | integer |
유사 날짜의 날짜입니다. |
|
|
개월
|
m | integer |
유사 항목 날짜의 월입니다. |
|
|
년
|
y | integer |
유사 날짜의 연도입니다. |
|
|
연락처인가요?
|
is_organization_contact | boolean |
구성 요소가 이 조직을 연락처로 나타내나요? |
|
|
연락처 유형
|
organization_contact_type | string |
조직을 연락처로 나타내는 관련 개인과의 상호 작용에 대한 컨텍스트를 제공합니다. |
|
|
Position
|
position | string |
조직에서 개인의 위치입니다. 문자 제한: 50. |
|
|
기본 비즈니스인가요?
|
is_primary_business | boolean |
이것이 구성 요소의 주요 사업인가요? |
|
|
비고
|
comment | string |
관계에 대한 추가 정보입니다. |
반환
조직 관계 만들기
조직 구성 요소 만들기
새 조직 구성 요소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름
|
name | True | string |
조직 이름입니다. 문자 제한: 100. |
|
조회 ID
|
lookup_id | string |
구성 요소에 대한 사용자 정의 식별자입니다. |
|
|
type
|
type | True | string |
주소 유형입니다. |
|
country
|
country | string |
주소의 국가(ID, 이름 또는 약어일 수 있습니다). |
|
|
라인
|
address_lines | string |
주소 줄입니다. 문자 제한: 150. |
|
|
city
|
city | string |
주소의 도시입니다(교외 필드와 함께 사용하지 마세요). |
|
|
주
|
state | string |
주소의 상태입니다. |
|
|
우편번호
|
postal_code | string |
주소의 우편 번호입니다. 문자 제한: 12. |
|
|
교외
|
suburb | string |
주소의 교외(도시 필드와 함께 사용하지 마세요). |
|
|
군
|
county | string |
주소의 카운티입니다. |
|
|
start
|
start | date |
구성 요소가 이 주소에 거주하기 시작한 날짜입니다(예: '2005-09-18'). |
|
|
끝
|
end | date |
구성 요소가 이 주소(예: '2005-09-18')에 거주하지 않는 날짜입니다. |
|
|
type
|
type | True | string |
전화 유형입니다. |
|
숫자
|
number | True | string |
전화 번호입니다. |
|
기본인가요?
|
primary | boolean |
이 번호가 구성 요소의 기본 전화 번호인가요? |
|
|
type
|
type | True | string |
전자 메일 주소의 유형입니다. |
|
address
|
address | True | string |
전자 메일 주소입니다. |
|
기본인가요?
|
primary | boolean |
이 주소가 구성 요소의 기본 이메일 주소인가요? |
|
|
type
|
type | True | string |
온라인 현재 상태 유형입니다. |
|
address
|
address | True | string |
온라인 상태의 웹 주소입니다. |
|
기본인가요?
|
primary | boolean |
이것은 구성 요소의 주요 온라인 존재인가요? |
|
|
익명으로 제공?
|
gives_anonymously | boolean |
구성 요소는 익명으로 제공합니까? |
|
|
전자 메일을 요청하지 않습니다.
|
requests_no_email | boolean |
구성 요소가 전자 메일을 요청하지 않나요? |
|
|
변호사가 있습니까?
|
is_solicitor | boolean |
구성 요소는 변호사인가요? |
|
|
유효한 주소가 없나요?
|
no_valid_address | boolean |
구성 요소에 유효한 주소가 없나요? |
|
|
목표/타겟
|
target | string |
구성 요소의 대상입니다. |
|
|
소득
|
income | string |
구성 요소의 소득입니다. |
|
|
영수증 유형
|
receipt_type | string |
구성 요소의 영수증 유형입니다. |
|
|
산업
|
industry | string |
구성 요소의 산업. |
|
|
직원 수
|
num_employees | integer |
조직의 직원 수입니다. |
|
|
선물과 일치하시겠습니까?
|
matches_gifts | boolean |
조직이 선물과 일치하나요? |
|
|
일치하는 기프트 팩터
|
matching_gift_factor | double |
일치하는 기프트 팩터입니다. |
|
|
선물당 최소 일치
|
value | double |
구성 요소에 대한 선물당 최소 일치 금액입니다. |
|
|
선물당 최대 일치 항목
|
value | double |
구성 요소의 선물당 최대 일치 금액입니다. |
|
|
constit당 최소 일치 항목
|
value | double |
구성 요소의 최소 일치 합계입니다. |
|
|
constit당 최대 일치 항목
|
value | double |
구성 요소의 최대 일치 합계입니다. |
|
|
일치하는 기프트 노트
|
matching_gift_notes | string |
구성 요소에 대한 일치하는 기프트 노트입니다. |
|
|
기념관인가요?
|
is_memorial | boolean |
구성 요소는 명예 / 기념인가? |
반환
조직 구성 요소 만들기
조회 ID로 구성 요소 가져오기
지정된 조회 ID에서 구성 요소의 시스템 레코드 ID를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
조회 ID
|
constituent_id | True | string |
구성 요소 조회 ID입니다. |
반환
구성 요소 ID 맵
중복 구성 요소 검색
개별, 조직 및 관련 연락처 레코드를 검색하고 지정된 검색 필터에 따라 잠재적 중복 항목의 순위를 지정합니다. 여러 필터와 일치하는 레코드는 잠재적 중복 항목으로 순위가 더 높습니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
성/조직 이름
|
last_org_name | True | string |
지정된 성 또는 조직 이름과 일치하는 레코드에 대한 필터입니다. |
|
이름 (이름의 첫 부분)
|
first_name | string |
지정된 이름과 일치하는 개별 레코드에 대한 필터입니다. |
|
|
중간 이름
|
middle_name | string |
지정된 중간 이름과 일치하는 개별 레코드에 대한 필터입니다. |
|
|
접미사
|
suffix | string |
지정된 접미사와 일치하는 개별 레코드에 대한 필터입니다. |
|
|
주소 블록
|
address_block | string |
지정된 주소 블록과 일치하는 레코드에 대한 필터입니다. |
|
|
도시
|
city | string |
지정된 도시와 일치하는 레코드에 대한 필터입니다. |
|
|
주
|
state | string |
지정된 상태와 일치하는 레코드에 대한 필터입니다. |
|
|
우편번호
|
post_code | string |
지정된 우편 번호와 일치하는 레코드에 대한 필터입니다. |
|
|
전자 메일
|
array |
지정된 전자 메일 주소와 일치하는 레코드에 대한 필터입니다. |
||
|
Phone
|
phone | array |
지정된 전화 번호와 일치하는 레코드에 대한 필터입니다. |
|
|
개인을 검색하시겠습니까?
|
search_individuals | boolean |
중복된 개별 레코드를 검색하시겠습니까? |
|
|
별칭을 검색하시겠습니까?
|
search_aliases | boolean |
Last/org 이름 매개 변수에 지정된 별칭으로 검색하시겠습니까? |
|
|
연락처를 검색하시겠습니까?
|
search_contacts | boolean |
관계 연락처 레코드를 검색하시겠습니까? |
|
|
한계
|
limit | integer |
페이징 결과를 페이징할 때 반환할 레코드 수입니다(기본값 = 3). |
|
|
상쇄
|
offset | integer |
페이징 결과를 페이징할 때 건너뛸 레코드 수입니다. |
반환
중복 검색 결과
정의
CommPrefApi.ConstituentConsentRead
구성 요소에 대한 동의 엔터티를 나타냅니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
동의 레코드의 시스템 레코드 ID입니다. |
|
채널
|
channel | string |
동의 응답이 적용되는 채널입니다. |
|
카테고리
|
category | string |
동의 응답이 적용되는 범주입니다. |
|
출처
|
source | string |
구성 요소의 동의 응답 원본입니다. |
|
응답
|
constituent_consent_response | string |
구성 요소가 지정된 채널/범주에 대한 동의에 응답하는 방식입니다. |
|
날짜
|
consent_date | date-time |
동의 응답을 받은 날짜입니다. |
|
동의 문
|
consent_statement | string |
동의를 제공할 때 구성 요소가 응답한 진술입니다. |
|
개인정보 처리방침
|
privacy_notice | string |
구성 요소에 제공된 개인 정보 보호 알림입니다. |
|
추가된 날짜
|
date_added | date-time |
동의 응답이 추가된 날짜입니다. |
|
추가한 사람
|
user_name | string |
동의 응답을 추가한 사용자입니다. |
CommPrefApi.ConstituentConsentReadCollection
동의 레코드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
목록의 동의 레코드 수입니다. |
|
value
|
value | array of CommPrefApi.ConstituentConsentRead |
응답에 포함된 동의 레코드 집합입니다. |
CommPrefApi.ConstituentSolicitCodeRead
코드 요청
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
구성 요소 요청 코드의 시스템 레코드 ID입니다. |
|
코드 요청
|
solicit_code | string |
구성 요소에 대한 통신 지침 및/또는 제한 사항입니다. |
|
시작 날짜
|
start_date | date |
요청 코드의 시작 날짜입니다(예: '2005-09-18'). |
|
끝 날짜
|
end_date | date |
요청 코드의 종료 날짜입니다(예: '2005-09-18'). |
CommPrefApi.ConstituentSolicitCodeReadCollection
코드 요청
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
목록의 구성 요소 요청 코드 수입니다. |
|
value
|
value | array of CommPrefApi.ConstituentSolicitCodeRead |
응답에 포함된 구성 요청 코드 집합입니다. |
CommPrefApi.CreatedConstituentConsent
구성 요소 동의 생성
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 동의 레코드의 ID입니다. |
CommPrefApi.CreatedConstituentSolicitCode
구성 요소 요청 코드 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 요청 코드의 ID입니다. |
ConstituentApi.AddressRead
Address
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
주소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
주소 유형입니다. |
|
국가
|
country | string |
주소의 국가(ID, 이름 또는 약어일 수 있습니다). |
|
주소 줄
|
address_lines | string |
주소 줄입니다. |
|
도시
|
city | string |
주소의 도시입니다(교외 필드와 함께 사용하지 마세요). |
|
주
|
state | string |
주소의 상태입니다. |
|
우편번호
|
postal_code | string |
주소의 우편 번호입니다. |
|
교외
|
suburb | string |
주소의 교외(도시 필드와 함께 사용하지 마세요). |
|
군
|
county | string |
주소의 카운티입니다. |
|
서식이 지정된 주소
|
formatted_address | string |
구성된 국가 형식의 서식이 지정된 주소입니다. |
|
정보 원본
|
information_source | string |
주소의 정보 원본입니다. |
|
지역
|
region | string |
주소의 지역입니다. |
|
카트
|
cart | string |
주소에 대한 CART(이동 통신 사업자 경로)입니다. |
|
많이
|
lot | string |
주소의 이동 줄(LOT)입니다. |
|
DPC
|
dpc | string |
주소의 DPC(배달 지점 코드)입니다. |
|
다음에서 유효합니다.
|
start | date-time |
구성 요소가 이 주소에 거주하기 시작한 날짜입니다. |
|
유효한 경우
|
end | date-time |
구성 요소가 이 주소에 거주하지 않게 된 날짜입니다. |
|
본래의?
|
preferred | boolean |
이 주소가 구성 요소의 기본 주소인가요? |
|
게으른?
|
inactive | boolean |
주소가 비활성 상태인가요(즉, 현재 날짜가 종료 날짜 이전임)? |
|
메일을 사용하지 않나요?
|
do_not_mail | boolean |
이 주소에서 구성 요소에 연락할 수 있나요? |
|
일
|
seasonal_start.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
seasonal_start.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
seasonal_start.y | integer |
유사 날짜의 연도입니다. |
|
일
|
seasonal_end.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
seasonal_end.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
seasonal_end.y | integer |
유사 날짜의 연도입니다. |
|
추가된 날짜
|
date_added | date-time |
주소를 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
주소가 마지막으로 수정된 날짜입니다. |
ConstituentApi.AliasRead
Alias
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
별칭의 시스템 레코드 ID입니다. |
|
Alias
|
name | string |
구성 요소의 별칭으로 사용할 이름입니다. |
|
유형
|
type | string |
별칭 형식입니다. |
ConstituentApi.ApiCollectionOfAddressRead
Addresses
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.AddressRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfAliasRead
Aliases
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.AliasRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfConstituentAttachmentRead
Attachments
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.ConstituentAttachmentRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfConstituentCodeRead
구성 요소 코드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.ConstituentCodeRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfConstituentCustomFieldRead
사용자 지정 필드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.ConstituentCustomFieldRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfConstituentRead
성분
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.ConstituentRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfEducationRead
교육
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.EducationRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfEmailAddressRead
이메일 주소
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.EmailAddressRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfFundraiserAssignmentRead
기금 모금 과제
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.FundraiserAssignmentRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfMembershipRead
Memberships
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.MembershipRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfNoteRead
비고
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.NoteRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfOnlinePresenceRead
온라인 상태
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.OnlinePresenceRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfPhoneRead
전화
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.PhoneRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfRelationshipRead
관계
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.RelationshipRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ApiCollectionOfSearchResultRead
검색 결과
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.SearchResultRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.ConstituentAttachmentRead
Attachment
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
첨부 파일의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
parent_id | string |
첨부 파일과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
첨부 파일 형식입니다. 실제 첨부 파일은 로컬 또는 네트워크에 저장된 이미지, PDF 또는 Word 문서와 같은 업로드된 파일입니다. 시스템에 저장되고 관리됩니다. 링크 첨부 파일은 온라인 또는 클라우드 스토리지 계정에 있는 이미지, 블로그 게시물 또는 YouTube 비디오와 같은 파일에 대한 링크입니다. 외부에 저장되고 관리됩니다. |
|
이름
|
name | string |
첨부 파일의 이름입니다. 문자 제한: 150. |
|
날짜
|
date | date-time |
첨부 파일의 날짜입니다. |
|
URL
|
url | string |
첨부 파일의 URL입니다. 이는 링크 첨부 파일에 필요하며 실제 첨부 파일에는 적용되지 않습니다. |
|
파일 이름
|
file_name | string |
파일 이름입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다. |
|
파일 ID
|
file_id | string |
파일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다. |
|
썸네일 ID
|
thumbnail_id | string |
썸네일의 식별자입니다. 문자 제한: 36. 실제 첨부 파일의 경우에만 해당합니다. |
|
썸네일 URL
|
thumbnail_url | string |
썸네일의 URL입니다. 이미지만 있는 실제 첨부 파일의 경우 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다. |
|
콘텐츠 형식
|
content_type | string |
콘텐츠 형식입니다. 실제 첨부 파일의 경우에만 해당합니다. |
|
파일 크기
|
file_size | integer |
파일 크기(바이트)입니다. 실제 첨부 파일의 경우에만 해당합니다. |
|
태그들
|
tags | array of string |
첨부 파일과 연결된 태그입니다. |
ConstituentApi.ConstituentCodeRead
구성 코드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
구성 코드의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
구성 요소 코드와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
구성 코드
|
description | string |
구성 요소 코드입니다. |
|
일
|
start.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
start.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
start.y | integer |
유사 날짜의 연도입니다. |
|
일
|
end.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
end.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
end.y | integer |
유사 날짜의 연도입니다. |
|
게으른?
|
inactive | boolean |
구성 코드가 비활성 상태인가요? |
|
순서
|
sequence | integer |
구성 요소 코드와 연결된 숫자 시퀀스입니다. |
|
추가된 날짜
|
date_added | date-time |
구성 코드가 만들어진 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
구성 코드가 마지막으로 수정된 날짜입니다. |
ConstituentApi.ConstituentCustomFieldRead
사용자 지정 필드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
사용자 지정 필드의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
parent_id | string |
사용자 지정 필드와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
카테고리
|
category | string |
사용자 지정 필드 범주입니다. |
|
유형
|
type | string |
사용자 지정 필드가 나타내는 데이터의 형식입니다. |
|
가치
|
value |
사용자 지정 필드의 값입니다. |
|
|
텍스트 값
|
text_value | string |
사용자 지정 필드의 텍스트 값입니다. |
|
숫자 값
|
number_value | integer |
사용자 정의 필드의 숫자 값입니다. |
|
날짜 값
|
date_value | date |
사용자 지정 필드의 날짜 값입니다. |
|
통화 값
|
currency_value | double |
사용자 지정 필드의 통화 값입니다. |
|
부울 값
|
boolean_value | boolean |
사용자 지정 필드의 부울 값입니다. |
|
테이블 항목 값
|
codetableentry_value | string |
사용자 지정 필드의 테이블 항목 값입니다. |
|
구성 요소 ID 값
|
constituentid_value | string |
사용자 지정 필드의 구성 요소 ID 값입니다. |
|
일
|
fuzzydate_value.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
fuzzydate_value.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
fuzzydate_value.y | integer |
유사 날짜의 연도입니다. |
|
날짜
|
date | date |
사용자 지정 필드의 날짜입니다. |
|
주석
|
comment | string |
사용자 지정 필드에 대한 주석입니다. 문자 제한: 50. |
|
추가된 날짜
|
date_added | date-time |
사용자 지정 필드를 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
사용자 지정 필드가 마지막으로 수정된 날짜입니다. |
ConstituentApi.ConstituentRead
성분
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
구성 요소의 시스템 레코드 ID입니다. 이는 lookup_id 저장된 사용자 정의 구성 요소 식별자와 동일하지 않습니다. |
|
유형
|
type | string |
구성 요소의 형식입니다. |
|
제목
|
title | string |
구성 요소의 기본 제목입니다(개인만 해당). |
|
이름 (이름의 첫 부분)
|
first | string |
구성 요소의 이름입니다(개인만 해당). |
|
성(姓)
|
last | string |
구성 요소의 성(개인만 해당)입니다. |
|
이름
|
name | string |
개인의 경우 이 필드는 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름입니다. 조직의 경우 조직의 이름입니다. |
|
기본 설정 이름
|
preferred_name | string |
구성 요소의 기본 설정 이름입니다(개인만 해당). |
|
접미사
|
suffix | string |
구성 요소의 기본 접미사입니다(개인만 해당). |
|
조회 ID
|
lookup_id | string |
구성 요소에 대한 사용자 정의 식별자입니다. |
|
아이디
|
email.id | string |
전자 메일 주소의 시스템 레코드 ID입니다. |
|
type
|
email.type | string |
전자 메일 주소의 유형입니다. |
|
address
|
email.address | string |
전자 메일 주소입니다. |
|
전자 메일을 보내지 않나요?
|
email.do_not_email | boolean |
이 전자 메일 주소에서 구성 요소에 연락할 수 있나요? |
|
게으른?
|
email.inactive | boolean |
이 전자 메일 주소가 비활성 상태인가요? |
|
추가된 날짜
|
email.date_added | date-time |
전자 메일 주소를 만든 날짜입니다. |
|
수정된 날짜
|
email.date_modified | date-time |
전자 메일 주소를 마지막으로 수정한 날짜입니다. |
|
아이디
|
phone.id | string |
휴대폰의 시스템 레코드 ID입니다. |
|
type
|
phone.type | string |
전화 유형입니다. |
|
숫자
|
phone.number | string |
전화 번호입니다. |
|
호출하지 않나요?
|
phone.do_not_call | boolean |
이 번호로 구성 요소에 연락할 수 있나요? |
|
게으른?
|
phone.inactive | boolean |
이 전화 번호가 비활성 상태인가요? |
|
추가된 날짜
|
phone.date_added | date-time |
휴대폰을 만든 날짜입니다. |
|
수정된 날짜
|
phone.date_modified | date-time |
휴대폰이 마지막으로 수정된 날짜입니다. |
|
아이디
|
online_presence.id | string |
온라인 상태의 시스템 레코드 ID입니다. |
|
type
|
online_presence.type | string |
온라인 현재 상태 유형입니다. |
|
link
|
online_presence.address | string |
온라인 상태의 웹 주소입니다. |
|
게으른?
|
online_presence.inactive | boolean |
이 온라인 프레즌스는 비활성 상태인가요? |
|
추가된 날짜
|
online_presence.date_added | date-time |
온라인 상태가 만들어진 날짜입니다. |
|
수정된 날짜
|
online_presence.date_modified | date-time |
온라인 상태가 마지막으로 수정된 날짜입니다. |
|
아이디
|
address.id | string |
주소의 시스템 레코드 ID입니다. |
|
type
|
address.type | string |
주소 유형입니다. |
|
country
|
address.country | string |
주소의 국가(ID, 이름 또는 약어일 수 있습니다). |
|
라인
|
address.address_lines | string |
주소 줄입니다. |
|
city
|
address.city | string |
주소의 도시입니다(교외 필드와 함께 사용하지 마세요). |
|
주
|
address.state | string |
주소의 상태입니다. |
|
우편번호
|
address.postal_code | string |
주소의 우편 번호입니다. |
|
교외
|
address.suburb | string |
주소의 교외(도시 필드와 함께 사용하지 마세요). |
|
군
|
address.county | string |
주소의 카운티입니다. |
|
포맷
|
address.formatted_address | string |
구성된 국가 형식의 서식이 지정된 주소입니다. |
|
유효한
|
address.start | date-time |
구성 요소가 이 주소에 거주하기 시작한 날짜입니다. |
|
유효한 경우
|
address.end | date-time |
구성 요소가 이 주소에 거주하지 않게 된 날짜입니다. |
|
게으른?
|
address.inactive | boolean |
주소가 비활성 상태인가요(즉, 현재 날짜가 종료 날짜 이전임)? |
|
메일을 사용하지 않나요?
|
address.do_not_mail | boolean |
이 주소에서 구성 요소에 연락할 수 있나요? |
|
일
|
address.seasonal_start.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
address.seasonal_start.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
address.seasonal_start.y | integer |
유사 날짜의 연도입니다. |
|
일
|
address.seasonal_end.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
address.seasonal_end.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
address.seasonal_end.y | integer |
유사 날짜의 연도입니다. |
|
추가된 날짜
|
address.date_added | date-time |
주소를 만든 날짜입니다. |
|
수정된 날짜
|
address.date_modified | date-time |
주소가 마지막으로 수정된 날짜입니다. |
|
성별
|
gender | string |
구성 요소의 성별(개인만 해당). |
|
중간 이름
|
middle | string |
구성 요소의 중간 이름입니다(개인만 해당). |
|
이전 이름
|
former_name | string |
구성 요소의 이전 이름입니다(개인만 해당). |
|
제목 2
|
title_2 | string |
구성 요소의 보조 제목입니다(개인만 해당). |
|
접미사 2
|
suffix_2 | string |
구성 요소의 보조 접미사입니다(개인만 해당). |
|
부부 부실
|
marital_status | string |
구성 요소의 결혼 상태(개인만 해당). |
|
익명으로 제공?
|
gives_anonymously | boolean |
구성 요소는 익명으로 제공합니까? |
|
전자 메일을 요청하지 않습니다.
|
requests_no_email | boolean |
구성 요소가 전자 메일을 요청하지 않나요? |
|
변호사가 있습니까?
|
is_solicitor | boolean |
구성 요소는 변호사인가요? |
|
유효한 주소가 없나요?
|
no_valid_address | boolean |
구성 요소에 유효한 주소가 없나요? |
|
게으른?
|
inactive | boolean |
구성 요소가 비활성 상태인가요? |
|
일
|
birthdate.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
birthdate.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
birthdate.y | integer |
유사 날짜의 연도입니다. |
|
출생지
|
birthplace | string |
구성 요소의 발상지입니다(개인만 해당). |
|
민족성
|
ethnicity | string |
구성 요소의 민족성(개인만 해당). |
|
목표/타겟
|
target | string |
구성 요소의 대상입니다. |
|
소득
|
income | string |
구성 요소의 소득입니다(개인만 해당). |
|
영수증 유형
|
receipt_type | string |
구성 요소의 영수증 유형입니다. |
|
종교
|
religion | string |
구성 요소의 종교(개인만 해당). |
|
산업
|
industry | string |
구성 요소의 산업(조직에만 해당). |
|
직원 수
|
num_employees | integer |
조직의 직원 수입니다. |
|
선물과 일치하시겠습니까?
|
matches_gifts | boolean |
조직이 선물과 일치하나요? |
|
일치하는 기프트 팩터
|
matching_gift_factor | double |
일치하는 기프트 팩터(조직에만 해당)입니다. |
|
value
|
matching_gift_per_gift_min.value | double |
금액 값입니다. |
|
value
|
matching_gift_per_gift_max.value | double |
금액 값입니다. |
|
value
|
matching_gift_total_min.value | double |
금액 값입니다. |
|
value
|
matching_gift_total_max.value | double |
금액 값입니다. |
|
일치하는 기프트 노트
|
matching_gift_notes | string |
구성 요소에 대한 일치하는 기프트 노트입니다(조직에만 해당). |
|
나이
|
age | integer |
생년월일 속성을 기반으로 계산된 구성 요소의 나이입니다(개인만 해당). |
|
고?
|
deceased | boolean |
구성 요소가 사망합니까 (개인만 해당)? |
|
일
|
deceased_date.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
deceased_date.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
deceased_date.y | integer |
유사 날짜의 연도입니다. |
|
모금 행사 상태
|
fundraiser_status | string |
구성 요소가 기금 모금 행사인지 여부를 나타냅니다(개인만 해당). |
|
기념관인가요?
|
is_memorial | boolean |
구성 요소는 명예 / 기념인가? |
|
아이디
|
spouse.id | string |
배우자의 시스템 레코드 ID입니다. |
|
이름
|
spouse.first | string |
배우자의 이름입니다. |
|
성
|
spouse.last | string |
배우자의 성입니다. |
|
가정의 머리인가요?
|
spouse.is_head_of_household | boolean |
배우자가 가정의 머리인가요? |
|
추가된 날짜
|
date_added | date-time |
구성 요소가 만들어진 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
구성 요소가 마지막으로 수정된 날짜입니다. |
ConstituentApi.ConvertedConstituent
변환된 구성 요소
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
변환된 구성 요소의 ID입니다. |
ConstituentApi.CreatedConstituentAddress
만든 구성 요소 주소
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 주소의 ID입니다. |
ConstituentApi.CreatedConstituentAlias
만든 구성 별칭
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 별칭의 ID입니다. |
ConstituentApi.CreatedConstituentAttachment
구성 요소 첨부 파일 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 첨부 파일의 ID입니다. |
ConstituentApi.CreatedConstituentCode
구성 요소 코드 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 코드의 ID입니다. |
ConstituentApi.CreatedConstituentCustomField
만든 구성 요소 사용자 정의 필드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 사용자 정의 필드의 ID입니다. |
ConstituentApi.CreatedConstituentEducation
구성 교육 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 교육의 ID입니다. |
ConstituentApi.CreatedConstituentEmailAddress
만든 구성 전자 메일 주소
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 전자 메일 주소의 ID입니다. |
ConstituentApi.CreatedConstituentNote
만든 구성 요소 노트
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 노트의 ID입니다. |
ConstituentApi.CreatedConstituentOnlinePresence
구성 요소 온라인 프레즌스 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 온라인 현재 상태의 ID입니다. |
ConstituentApi.CreatedConstituentPhone
만든 구성 전화
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 전화의 ID입니다. |
ConstituentApi.CreatedIndividualConstituent
개별 구성 요소 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 개별 구성 요소의 ID입니다. |
ConstituentApi.CreatedIndividualRelationship
개별 관계 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 개별 관계의 ID입니다. |
ConstituentApi.CreatedNameFormat
만든 이름 형식
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 이름 형식의 ID입니다. |
ConstituentApi.CreatedOrganizationConstituent
조직 구성 요소 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 조직 구성 요소의 ID입니다. |
ConstituentApi.CreatedOrganizationRelationship
조직 관계 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 조직 관계의 ID입니다. |
ConstituentApi.DuplicateSearchResult
중복 검색 결과
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
구성 요소의 시스템 레코드 ID입니다. |
|
이름
|
name | string |
구성 요소 이름입니다. 개인의 경우 이 계산 필드는 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름을 나타냅니다. |
|
표시 이름
|
display_name | string |
구성 요소의 표시 이름입니다. |
|
Address
|
formatted_address | string |
구성 요소의 서식이 지정된 기본 주소입니다. |
|
고?
|
deceased | boolean |
성분이 죽었습니까? |
|
구성 요소인가요?
|
is_constituent | boolean |
레코드가 구성 요소인가요? |
|
조회 ID
|
constituent_id | string |
구성 요소에 대한 사용자 정의 식별자입니다. |
|
추가된 날짜
|
date_added | date-time |
구성 요소가 추가된 날짜입니다. |
|
등급
|
rank | string |
구성 요소가 일치하는 항목을 나타내는 검색 순위입니다. |
ConstituentApi.DuplicateSearchResultCollection
중복 검색 결과
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of ConstituentApi.DuplicateSearchResult |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
ConstituentApi.EducationRead
Education
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
교육의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
교육과 관련된 구성 요소의 시스템 레코드 ID입니다. |
|
학교
|
school | string |
학교/설립 이름입니다. |
|
유형
|
type | string |
교육 유형입니다. |
|
의 클래스
|
class_of | string |
구성 요소가 졸업한 해입니다. |
|
상태
|
status | string |
교육의 상태입니다. |
|
일
|
date_entered.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
date_entered.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
date_entered.y | integer |
유사 날짜의 연도입니다. |
|
일
|
date_left.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
date_left.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
date_left.y | integer |
유사 날짜의 연도입니다. |
|
일
|
date_graduated.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
date_graduated.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
date_graduated.y | integer |
유사 날짜의 연도입니다. |
|
정도
|
degree | string |
받은 학위입니다. |
|
GPA
|
gpa | double |
성적 포인트 평균입니다. |
|
전공
|
majors | array of string |
연구의 주요 과정. |
|
미성년자
|
minors | array of string |
연구의 사소한 과정. |
|
초등 교육인가요?
|
primary | boolean |
이것이 선거구의 초등학교 협회인가요? |
|
Campus
|
campus | string |
캠퍼스. |
|
소셜 조직
|
social_organization | string |
사회 조직. |
|
알려진 이름
|
known_name | string |
알려진 이름입니다. |
|
학위의 클래스
|
class_of_degree | string |
학위의 클래스입니다. |
|
부서
|
department | string |
교육 부서의 이름입니다. |
|
학부
|
faculty | string |
교직원의 이름입니다. |
|
등록 번호
|
registration_number | string |
등록 번호입니다. |
|
연구 대상
|
subject_of_study | string |
연구의 주제입니다. |
|
추가된 날짜
|
date_added | date-time |
교육이 만들어진 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
교육이 마지막으로 수정된 날짜입니다. |
ConstituentApi.EmailAddressRead
전자 메일 주소
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
전자 메일 주소의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
전자 메일 주소와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
전자 메일 유형
|
type | string |
전자 메일 주소의 유형입니다. |
|
전자 메일 주소
|
address | string |
전자 메일 주소입니다. |
|
본래의?
|
primary | boolean |
이 주소가 구성 요소의 기본 이메일 주소인가요? |
|
전자 메일을 보내지 않나요?
|
do_not_email | boolean |
이 전자 메일 주소에서 구성 요소에 연락할 수 있나요? |
|
게으른?
|
inactive | boolean |
이 전자 메일 주소가 비활성 상태인가요? |
|
추가된 날짜
|
date_added | date-time |
전자 메일 주소를 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
전자 메일 주소를 마지막으로 수정한 날짜입니다. |
ConstituentApi.FundraiserAssignmentRead
모금 행사 할당
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
모금 행사 할당의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
모금 행사에 할당된 구성 요소의 시스템 레코드 ID입니다. |
|
모금 행사 ID
|
fundraiser_id | string |
모금 행사의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
모금 행사의 유형입니다. |
|
value
|
amount.value | double |
통화 값입니다. |
|
캠페인 ID
|
campaign_id | string |
결과 선물을 적용할 캠페인의 시스템 레코드 ID입니다. |
|
펀드 ID
|
fund_id | string |
모든 결과 선물을 적용해야 하는 펀드의 시스템 레코드 ID입니다. 제한된 기금이 선택되면 해당 기금과 관련된 캠페인 및 이의 제기만 선택할 수 있습니다. |
|
항소 ID
|
appeal_id | string |
기금 모금이 선물을 요청하는 데 사용해야 하는 항소의 시스템 레코드 ID입니다. |
|
시작 날짜
|
start | date-time |
모금 행사 배정 시작 날짜입니다. |
|
끝 날짜
|
end | date-time |
모금 행사 배정 종료 날짜입니다. |
ConstituentApi.MembershipMemberRead
회원
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
멤버의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
멤버와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
주 멤버인가요?
|
primary | boolean |
주 멤버인가요? |
ConstituentApi.MembershipRead
Membership
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
멤버 자격의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
멤버 자격과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
프로그램
|
program | string |
멤버 자격 프로그램입니다. |
|
카테고리
|
category | string |
멤버 자격 범주입니다. |
|
하위 범주
|
subcategory | string |
멤버 자격 하위 범주입니다. |
|
서
|
standing | string |
멤버 자격 상태입니다. |
|
만료
|
expires | date-time |
멤버 자격이 만료되는 날짜입니다. |
|
합류
|
joined | date-time |
멤버 자격이 활성화되는 날짜입니다. |
|
value
|
dues.value | double |
통화 값입니다. |
|
구성원
|
members | array of ConstituentApi.MembershipMemberRead |
멤버 자격에 속한 멤버 집합입니다. |
|
추가된 날짜
|
date_added | date-time |
멤버 자격을 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
멤버 자격이 마지막으로 수정된 날짜입니다. |
ConstituentApi.NameFormatRead
이름 형식은 통신에서 구성 요소를 처리하는 방법을 정의합니다. 개인을 참조하는 방법은 개인과의 통신 톤과 상호 작용을 얼마나 잘 받는지를 설정합니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
이름 형식의 시스템 레코드 ID입니다. |
|
type
|
type | string |
이름 형식 형식입니다. |
|
사용자 지정 형식인가요?
|
custom_format | boolean |
사용자 지정 형식인가요? |
|
구성 ID
|
configuration_id | string |
이름 형식의 구성 ID입니다(사용자 지정이 아닌 형식의 경우). |
|
서식이 지정된 이름
|
formatted_name | string |
서식이 지정된 이름(사용자 지정 형식의 경우)입니다. |
ConstituentApi.NameFormatSummaryRead
이름 형식 요약
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
primary_addressee.id | string |
이름 형식의 시스템 레코드 ID입니다. |
|
type
|
primary_addressee.primary_type | string |
이름 형식 형식입니다. |
|
사용자 지정 형식인가요?
|
primary_addressee.custom_format | boolean |
사용자 지정 형식인가요? |
|
구성 ID
|
primary_addressee.configuration_id | string |
이름 형식의 구성 ID입니다(사용자 지정이 아닌 형식의 경우). |
|
서식이 지정된 이름
|
primary_addressee.formatted_name | string |
서식이 지정된 이름(사용자 지정 형식의 경우)입니다. |
|
아이디
|
primary_salutation.id | string |
이름 형식의 시스템 레코드 ID입니다. |
|
type
|
primary_salutation.primary_type | string |
이름 형식 형식입니다. |
|
사용자 지정 형식인가요?
|
primary_salutation.custom_format | boolean |
사용자 지정 형식인가요? |
|
구성 ID
|
primary_salutation.configuration_id | string |
이름 형식의 구성 ID입니다(사용자 지정이 아닌 형식의 경우). |
|
서식이 지정된 이름
|
primary_salutation.formatted_name | string |
서식이 지정된 이름(사용자 지정 형식의 경우)입니다. |
|
추가 이름 형식
|
additional_name_formats | array of ConstituentApi.NameFormatRead |
구성 요소의 추가 이름 형식입니다. |
ConstituentApi.NoteRead
비고
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
메모의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
메모와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
메모 유형입니다. |
|
일
|
date.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
date.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
date.y | integer |
유사 날짜의 연도입니다. |
|
요약
|
summary | string |
메모 요약입니다. |
|
비고
|
text | string |
메모 텍스트입니다. |
|
추가된 날짜
|
date_added | date-time |
메모를 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
메모가 마지막으로 수정된 날짜입니다. |
ConstituentApi.OnlinePresenceRead
온라인 상태
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
온라인 상태의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
온라인 상태와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
온라인 현재 상태 유형입니다. |
|
Link
|
address | string |
온라인 상태의 웹 주소입니다. |
|
본래의?
|
primary | boolean |
이것은 구성 요소의 주요 온라인 존재인가요? |
|
게으른?
|
inactive | boolean |
이 온라인 프레즌스는 비활성 상태인가요? |
|
추가된 날짜
|
date_added | date-time |
온라인 상태가 만들어진 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
온라인 상태가 마지막으로 수정된 날짜입니다. |
ConstituentApi.PhoneRead
Phone
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
휴대폰의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
휴대폰과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
전화 유형입니다. |
|
Number
|
number | string |
전화 번호입니다. |
|
본래의?
|
primary | boolean |
이것은 구성 요소의 기본 전화인가요? |
|
호출하지 않나요?
|
do_not_call | boolean |
이 번호로 구성 요소에 연락할 수 있나요? |
|
게으른?
|
inactive | boolean |
이 전화 번호가 비활성 상태인가요? |
|
추가된 날짜
|
date_added | date-time |
휴대폰을 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
휴대폰이 마지막으로 수정된 날짜입니다. |
ConstituentApi.ProfilePictureRead
프로필 사진
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
구성 요소 ID
|
constituent_id | string |
프로필 사진과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
URL
|
url | string |
프로필 사진의 URL입니다. URL에는 액세스를 60분으로 제한하는 시간 제한 서명이 포함되어 있습니다. |
|
썸네일 URL
|
thumbnail_url | string |
프로필 사진의 썸네일 URL입니다. 액세스를 60분으로 제한하는 시간 제한 서명을 포함합니다. |
ConstituentApi.RelationshipRead
관계
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
관계의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
관계와 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
관계 ID
|
relation_id | string |
관련 개인 또는 조직의 시스템 레코드 ID입니다. |
|
상호 관계 ID
|
reciprocal_relationship_id | string |
상호 관계 레코드의 식별자입니다. 이 값은 읽기 전용이며 관계가 만들어지면 자동으로 생성됩니다. 이 레코드의 변경 내용도 주석 속성을 제외하고 상호에 반영됩니다. |
|
이름
|
name | string |
관련 구성 요소의 이름입니다. 관련 구성 요소가 개인인 경우 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름이 됩니다. |
|
유형
|
type | string |
관계가 나타내는 관계의 형식입니다. |
|
상호 형식
|
reciprocal_type | string |
관련 구성 요소와 구성 요소의 관계를 설명합니다. 예를 들어, 남성 구성 요소와 여성 형제 간의 관계에서 상호 관계 유형은 형제가 됩니다. |
|
일
|
start.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
start.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
start.y | integer |
유사 날짜의 연도입니다. |
|
일
|
end.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
end.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
end.y | integer |
유사 날짜의 연도입니다. |
|
배우자인가요?
|
is_spouse | boolean |
관련 개인이 구성 요소의 배우자인가요(개인 간의 관계에만 적용됨)? |
|
가구의 구성 머리인가요?
|
is_constituent_head_of_household | boolean |
구성 요소는 가정의 머리인가? |
|
배우자는 가정의 머리인가요?
|
is_spouse_head_of_household | boolean |
배우자가 가정의 머리인가요? |
|
비고
|
comment | string |
관계에 대한 주석입니다. |
|
연락처인가요?
|
is_organization_contact | boolean |
구성 요소가 이 조직을 연락처로 나타내나요(조직과 개인 간의 관계에만 적용됨)? |
|
기본 비즈니스인가요?
|
is_primary_business | boolean |
구성 요소의 기본 비즈니스인가요(조직과 개인 간의 관계에만 적용됨)? |
|
연락처 유형
|
organization_contact_type | string |
조직을 연락처로 나타내는 관련 개인과의 상호 작용에 대한 컨텍스트를 제공합니다. 조직과 개인 간의 관계에만 적용됩니다. |
|
Position
|
position | string |
조직에서 개인의 위치입니다. 조직과 개인 간의 관계에만 적용됩니다. |
|
추가된 날짜
|
date_added | date-time |
관계가 만들어진 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
관계가 마지막으로 수정된 날짜입니다. |
ConstituentApi.SearchResultRead
검색 결과
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
구성 요소의 시스템 레코드 ID입니다. |
|
이름
|
name | string |
구성 요소 이름입니다. 개인의 경우 이 계산 필드는 대상 조직의 표시 이름 설정에 따라 구성 요소의 전체 이름을 나타냅니다. |
|
Address
|
address | string |
구성 요소의 기본 주소입니다. |
|
고?
|
deceased | boolean |
성분이 죽었습니까? |
|
전자 메일
|
string |
구성 요소의 이메일 주소입니다. |
|
|
모금 행사 상태
|
fundraiser_status | string |
구성 요소의 기금 모금 상태입니다. 개인의 경우 이 계산 필드는 구성 요소가 활성, 비활성 또는 없음인지 여부를 나타냅니다. 조직의 경우 이 값은 항상 None입니다. |
|
게으른?
|
inactive | boolean |
구성 요소가 비활성 상태인가요? |
|
조회 ID
|
lookup_id | string |
구성 요소에 대한 사용자 정의 식별자입니다. |
FundraisingApi.ApiCollectionOfFundraiserAssignmentRead
Assignments
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of FundraisingApi.FundraiserAssignmentRead |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
FundraisingApi.CreatedFundraiserAssignment
모금 행사 할당 만들기
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 모금 행사 할당의 ID입니다. |
FundraisingApi.FundraiserAssignmentRead
Assignment
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
모금 행사 할당의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_id | string |
할당된 구성 요소의 시스템 레코드 ID입니다. |
|
유형
|
type | string |
모금 행사 유형입니다. |
|
할당 시작
|
start | date-time |
배정의 시작 날짜입니다. |
|
할당 종료
|
end | date-time |
배정의 종료 날짜입니다. |
|
value
|
amount.value | double |
통화 값입니다. |
|
캠페인 ID
|
campaign_id | string |
결과 선물을 적용할 캠페인의 시스템 레코드 ID입니다. |
|
펀드 ID
|
fund_id | string |
결과 선물을 적용할 펀드의 시스템 레코드 ID입니다. |
|
항소 ID
|
appeal_id | string |
결과 선물을 적용할 항소의 시스템 레코드 ID입니다. |
NXTDataIntegrationApi.ConstituentIdMap
구성 요소 ID 맵
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
system_record_id | integer |
구성 요소 시스템 레코드 ID입니다. |
NXTDataIntegrationApi.ConstituentSearchResult
검색 결과
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
record_id | integer |
구성 요소의 시스템 레코드 ID입니다. |
|
조회 ID
|
constituent_id | string |
구성 요소 ID입니다. |
|
키 표시기
|
key_indicator | string |
레코드의 키 표시기입니다. |
|
이름 (이름의 첫 부분)
|
first_name | string |
이름(개인만 해당)입니다. |
|
성(姓)
|
last_name | string |
성(개인만 해당)입니다. |
|
중간 이름
|
middle_name | string |
중간 이름(개인만 해당)입니다. |
|
기본 설정 이름
|
preferred_name | string |
기본 설정 이름(개인만 해당)입니다. |
|
이전 이름
|
maiden_name | string |
이전 이름(개인만 해당)입니다. |
|
제목 1
|
title1 | string |
제목 1(개인만 해당)입니다. |
|
접미사 1
|
suffix1 | string |
접미사 1(개인만 해당)입니다. |
|
성별
|
gender | string |
구성 성별(개인만 해당)입니다. |
|
일
|
birth_date.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
birth_date.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
birth_date.y | integer |
유사 날짜의 연도입니다. |
|
배우자 이름
|
spouse_first_name | string |
배우자의 이름(개인만 해당)입니다. |
|
배우자 성
|
spouse_last_name | string |
배우자의 성(개인만 해당)입니다. |
|
조직 이름
|
org_name | string |
조직 이름(조직만 해당)입니다. |
|
주소 블록
|
address_block | string |
주소 블록입니다. |
|
도시 및 주
|
address_city_state | string |
주소 도시 및 주입니다. |
|
우편번호
|
address_post_code | string |
주소 우편 번호입니다. |
|
기본 이메일 주소
|
primary_email | string |
기본 전자 메일입니다. |
|
기본 전화 번호
|
primary_phone | string |
기본 전화입니다. |
|
일치하는 별칭
|
matched_alias | string |
일치하는 별칭 이름입니다(개인만 해당). |
|
일치하는 전자 메일
|
matched_email | string |
일치하는 전자 메일 주소입니다. |
|
휴대폰 일치
|
matched_phone | string |
일치하는 전화 번호입니다. |
|
구성 요소인가요?
|
is_constituent | boolean |
레코드가 구성 요소인가요? |
|
고인인가요?
|
is_deceased | boolean |
레코드가 사망합니까? |
|
비활성 상태인가요?
|
is_inactive | boolean |
레코드가 비활성 상태인가요? |
NXTDataIntegrationApi.ConstituentSearchResultCollection
성분
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
results
|
results | array of NXTDataIntegrationApi.ConstituentSearchResult |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
NXTDataIntegrationApi.CreatedConstituentTribute
만든 구성 요소 공물
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 구성 요소 공물의 ID입니다. |
NXTDataIntegrationApi.CreatedTributeAcknowledgee
만든 공물 승인
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | string |
새로 만든 공물 승인의 ID입니다. |
NXTDataIntegrationApi.Tribute
공물
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
공물의 시스템 레코드 ID입니다. |
|
구성 요소 ID
|
constituent_record_id | integer |
공물과 연결된 구성 요소의 시스템 레코드 ID입니다. |
|
헌정 유형
|
tribute_type_name | string |
헌정 형식입니다. |
|
헌정 형식 ID
|
tribute_type_id | integer |
헌정 형식 ID입니다. |
|
Description
|
description | string |
공물 설명입니다. |
|
일
|
start_date.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
start_date.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
start_date.y | integer |
유사 날짜의 연도입니다. |
|
일
|
end_date.d | integer |
유사 날짜의 날짜입니다. |
|
개월
|
end_date.m | integer |
유사 항목 날짜의 월입니다. |
|
년
|
end_date.y | integer |
유사 날짜의 연도입니다. |
|
기본 펀드 ID
|
default_fund_id | integer |
공물과 연결된 기본 펀드의 시스템 레코드 ID입니다. |
|
비고
|
notes | string |
공물 노트. |
|
활동적인?
|
is_active | boolean |
이 공물은 활성화되어 있습니까? |
|
순서
|
sequence | integer |
공물 시퀀스입니다. |
|
추가된 날짜
|
date_added | date-time |
공물을 만든 날짜입니다. |
|
수정된 날짜
|
date_modified | date-time |
공물을 마지막으로 수정한 날짜입니다. |
NXTDataIntegrationApi.TributeAcknowledgee
공물 인정
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
승인된 공물의 시스템 레코드 ID입니다. |
|
공물 ID
|
tribute_id | integer |
승인과 연결된 공물의 시스템 레코드 ID입니다. |
|
관계 ID
|
relationships_id | integer |
관계의 시스템 레코드 ID입니다(null인 경우 자체 승인을 나타낸다). |
|
문자 ID
|
letter | integer |
문자 ID입니다. |
|
순서
|
sequence | integer |
공물은 시퀀스를 인정합니다. |
NXTDataIntegrationApi.TributeAcknowledgeeCollection
공물 인정
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of NXTDataIntegrationApi.TributeAcknowledgee |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |
NXTDataIntegrationApi.TributeCollection
공 물
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
수량
|
count | integer |
요청 매개 변수를 적용한 후 컬렉션으로 검색할 수 있는 항목 수입니다. 제한 및 오프셋 매개 변수는 개수에 영향을 미치지 않지만 페이징을 용이하게 하기 위해 값 결과 집합의 항목 수에 영향을 줄 수 있습니다. |
|
value
|
value | array of NXTDataIntegrationApi.Tribute |
응답에 포함된 항목 집합입니다. 컬렉션에 있는 항목의 하위 집합일 수 있습니다. |