The following operations are available for this resource.
Http Verb | Operation | ||
---|---|---|---|
GET | Method: Get, URL: CRM/Addresses/{addressId} | Test | |
Get details of an address using addressId as a URL query parameter. Returns 404 Not Found if an address with the specified Id is not found. |
|||
GET | Method: GetAll, URL: CRM/Addresses?constituentId={constituentId}&includeAffiliations={includeAffiliations}&primaryOnly={primaryOnly}&includeFromAffiliations={includeFromAffiliations} | Test | |
Get details of all the addresses for the specified constituent id and all its visible affiliation's addresses as well. To exclude addresses of the visible affiliations pass includeAffiliations=false. To get only the primary addresses, pass primaryOnly=true. |
|||
POST | Method: Create, URL: CRM/Addresses | Test | |
Create a new address for a Constituent by sending an XML or JSON representation of an Address object using HTTP POST. |
|||
PUT | Method: Update, URL: CRM/Addresses/{addressId} | Test | |
Update an address for a Constituent by sending an XML or JSON representation of an existing Address object using HTTP PUT. |
|||
DELETE | Method: Delete, URL: CRM/Addresses/{addressId} | Test | |
Delete an address along with all the phones attached to the address. Primary address for a Constituent cannot be deleted. |