getAddress: Get a specific Address

In samterfa/SkywardSDK: Creates R Functions for Skyward Generic API Functions

Description

This function returns fields for an Address.

Usage

getAddress(
  AddressID,
  EntityID = 1,
  returnAddressID = F,
  returnAddressLine2 = F,
  returnAddressRangeNumericStreetNumber = F,
  returnAddressRangeNumericStreetNumberIsOdd = F,
  returnAddressSecondaryUnitID = F,
  returnAddressType = F,
  returnAddressTypeCode = F,
  returnCountyID = F,
  returnCreatedTime = F,
  returnFormattedFullAddress = F,
  returnFreeformAddress = F,
  returnFullAddress = F,
  returnGeoID = F,
  returnInternationalAddress1 = F,
  returnInternationalAddress2 = F,
  returnInternationalAddress3 = F,
  returnInternationalAddress4 = F,
  returnIsLoadedLatitudeLongitude = F,
  returnLatitude = F,
  returnLatitudeLongitudeConfidence = F,
  returnLongitude = F,
  returnModifiedTime = F,
  returnPOBox = F,
  returnPrintableHTMLAddress = F,
  returnSecondaryUnitNumber = F,
  returnStreetID = F,
  returnStreetNumber = F,
  returnStreetNumberAndName = F,
  returnStreetNumberAndNameIncludeSecondaryUnit = F,
  returnUserIDCreatedBy = F,
  returnUserIDModifiedBy = F,
  returnZipCodeAddOn = F,
  returnZipCodeWithAddon = F,
  returnZipCodeWithAddonNoHyphen = F,
  returnZipID = F
)

Arguments

AddressID	The id of the Address. Run getAllAddresses for a list of Addresses.
EntityID	The id of the entity. Run getAllEntities for a list of entities.
returnFieldName	A TRUE or FALSE value determining whether or not to return FieldName for the given object. Defaults to FALSE for all return fields which for convenience returns all fields for the object.

Value

Details for the Address.

References

{yourApiUrl}/swagger

Skyward's Knowledge Hub

samterfa/SkywardSDK documentation built on Oct. 13, 2020, 6:53 a.m.