Get All Addresses for Record

Gets additional information for the specified record.

Resource Information

Scope	records Deprecated scope name: get_record_addresses
App Type	All
Authorization Type	No authorization required
URI	/v4/records/{recordId}/addresses?lang={lang}&isPrimary={isPrimary}&fields={fields}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.	7.3.2
isPrimary	string	No	Y \| N	Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.addressLine1	string	The first line of the address.	7.3.2
result.addressLine2	string	The second line of the address.	7.3.2
result.addressTypeFlag	result.addressTypeFlag{}	The current status of the address record.	7.3.2
result.addressTypeFlag.text	string	The localized display text.	7.3.2
result.addressTypeFlag.value	string	The value for the specified parameter.	7.3.2
result.city	string	The name of the city.	7.3.2
result.country	result.country{}	The name of the country.	7.3.2
result.country.text	string	The localized display text.	7.3.2
result.country.value	string	The value for the specified parameter.	7.3.2
result.county	string	The name of the county.	7.3.2
result.description	string	The description of the record or item.	7.3.2
result.direction	result.direction{}	The street direction of the primary address associated with the application.	7.3.2
result.direction.text	string	The localized display text.	7.3.2
result.direction.value	string	The value for the specified parameter.	7.3.2
result.distance	double	The distance from another landmark used to locate the address.	7.3.2
result.houseAlphaEnd	string	The ending street number that makes up the address.	7.3.2
result.houseAlphaStart	string	The beginning street number that makes up the address.	7.3.2
result.houseFractionEnd	result.houseFractionEnd{}	Used in combination with the Street # fields.	7.3.2
result.houseFractionEnd.text	string	The localized display text.	7.3.2
result.houseFractionEnd.value	string	The value for the specified parameter.	7.3.2
result.houseFractionStart	result.houseFractionStart{}	Used In combination with the Street # fields.	7.3.2
result.houseFractionStart.text	string	The localized display text.	7.3.2
result.houseFractionStart.value	string	The value for the specified parameter.	7.3.2
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.inspectionDistrict	string	The inspection district where the address is located.	7.3.2
result.inspectionDistrictPrefix	string	The prefix for the inspection district where the address is located.	7.3.2
result.isPrimary	string	Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time.	7.3.2
result.levelEnd	string	The ending level number (floor number) that makes up the address within a complex.	7.3.2
result.levelPrefix	string	The prefix for the level numbers (floor numbers) that make up the address.	7.3.2
result.levelStart	string	The beginning level number (floor number) that makes up the address within a complex.	7.3.2
result.neighborhood	string	The neighborhood where the address is located.	7.3.2
result.neighborhoodPrefix	string	The prefix for the neighborhood where the address is located.	7.3.2
result.postalCode	string	The postal ZIP code for the address.	7.3.2
result.recordId	result.recordId{}	The unique ID associated with a record.	7.3.2
result.recordId.customId	string	An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.	7.3.2
result.recordId.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.recordId.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.recordId.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.recordId.value	string	The value for the specified parameter.	7.3.2
result.refAddressId	long	The unique Id generated for an address stored in the system.	7.3.2
result.secondaryStreet	string	This field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location.	7.3.2
result.secondaryStreetNumber	long	This field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.state	result.state{}	The state corresponding to the address on record.	7.3.2
result.state.text	string	The localized display text.	7.3.2
result.state.value	string	The value for the specified parameter.	7.3.2
result.status	result.status{}	The address status indicating whether the address is active or inactive.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.streetAddress	string	The street address.	7.3.2
result.streetEnd	long	The end of a range of street numbers.	7.3.2
result.streetEndFrom	long	The start of the street End range.	7.3.2
result.streetEndTo	long	The last of the street End range.	7.3.2
result.streetName	string	The street name for the address.	7.3.2
result.streetPrefix	string	Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.	7.3.2
result.streetStart	long	The start of a range of street numbers.	7.3.2
result.streetStartFrom	long	The first of the street start range.	7.3.2
result.streetStartTo	long	The last of the street start range.	7.3.2
result.streetSuffix	result.streetSuffix{}	The type of street such as "Lane" or "Boulevard".	7.3.2
result.streetSuffix.text	string	The localized display text.	7.3.2
result.streetSuffix.value	string	The value for the specified parameter.	7.3.2
result.streetSuffixDirection	result.streetSuffixDirection{}	The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.	7.3.2
result.streetSuffixDirection.text	string	The localized display text.	7.3.2
result.streetSuffixDirection.value	string	The value for the specified parameter.	7.3.2
result.type	result.type{}	The address type.	7.3.2
result.type.text	string	The localized display text.	7.3.2
result.type.value	string	The value for the specified parameter.	7.3.2
result.unitEnd	string	The end parameter of a range of unit numbers.	7.3.2
result.unitStart	string	The starting parameter of a range of unit numbers.	7.3.2
result.unitType	result.unitType{}	The unit type designation of the address.	7.3.2
result.unitType.text	string	The localized display text.	7.3.2
result.unitType.value	string	The value for the specified parameter.	7.3.2
result.xCoordinate	double	The longitudinal coordinate for this address.	7.3.2
result.yCoordinate	double	The latitudinal coordinate for this address.	7.3.2
status	integer	The record status.	7.3.3