result | result{} | � | 7.3.3.4 |
result.address | result.address{} | The citizen user's address. | 7.3.3.4 |
result.address.addressLine1 | string | The first line of the address. | 7.3.3.4 |
result.address.addressLine2 | string | The second line of the address. | 7.3.3.4 |
result.address.addressLine3 | string | The third line of the address. | 7.3.3.4 |
result.address.city | string | The name of the city. | 7.3.3.4 |
result.address.country | result.address.country{} | The name of the country. | 7.3.3.4 |
result.address.country.text | string | The localized display text. | 7.3.3.4 |
result.address.country.value | string | The value for the specified parameter. | 7.3.3.4 |
result.address.state | result.address.state{} | The state corresponding to the address on record. | 7.3.3.4 |
result.address.state.text | string | The localized display text. | 7.3.3.4 |
result.address.state.value | string | The value for the specified parameter. | 7.3.3.4 |
result.address.zip | string | The address zip code. | 7.3.3.4 |
result.birthCity | result.birthCity{} | The city of birth for an individual. | 7.3.3.4 |
result.birthCity.text | string | The localized display text. | 7.3.3.4 |
result.birthCity.value | string | The value for the specified parameter. | 7.3.3.4 |
result.birthDate | dateTime | The birth date of an individual. | 7.3.3.4 |
result.birthRegion | result.birthRegion{} | The country of birth or region of birth for an individual. | 7.3.3.4 |
result.birthRegion.text | string | The localized display text. | 7.3.3.4 |
result.birthRegion.value | string | The value for the specified parameter. | 7.3.3.4 |
result.birthState | result.birthState{} | The state of birth for an individual. | 7.3.3.4 |
result.birthState.text | string | The localized display text. | 7.3.3.4 |
result.birthState.value | string | The value for the specified parameter. | 7.3.3.4 |
result.businessName | string | A secondary business name for the applicable individual. | 7.3.3.4 |
result.businessName2 | string | A secondary business name. | 7.3.3.4 |
result.comment | string | Comments or notes about the current context. | 7.3.3.4 |
result.contactAddresses[] | result.contactAddresses{} | Contains the contact address information. | 7.3.3.4 |
result.contactAddresses.addressLine1 | string | The first line of the address. | 7.3.3.4 |
result.contactAddresses.addressLine2 | string | The second line of the address. | 7.3.3.4 |
result.contactAddresses.addressLine3 | string | The third line of the address. | 7.3.3.4 |
result.contactAddresses.city | string | The name of the city. | 7.3.3.4 |
result.contactAddresses.country | result.contactAddresses.country{} | The name of the country. | 7.3.3.4 |
result.contactAddresses.country.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.country.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.effectiveDate | dateTime | The date when you want the condition to become effective. | 7.3.3.4 |
result.contactAddresses.entityID | long | The unique ID of the entity or record. | 7.3.3.4 |
result.contactAddresses.expirationDate | dateTime | The date when the condition expires. | 7.3.3.4 |
result.contactAddresses.fax | string | The fax number for the contact. | 7.3.3.4 |
result.contactAddresses.faxCountryCode | string | Fax Number Country Code | 7.3.3.4 |
result.contactAddresses.fullAddress | string | The full address. | 7.3.3.4 |
result.contactAddresses.houseNumberAlphaEnd | string | The alphabetic ending street number that makes up the address. | 7.3.3.4 |
result.contactAddresses.houseNumberAlphaStart | string | The alphabetic beginning street number that makes up the address. | 7.3.3.4 |
result.contactAddresses.houseNumberEnd | long | The ending street number that makes up the address. | 7.3.3.4 |
result.contactAddresses.houseNumberStart | long | The beginning street number that makes up the address. | 7.3.3.4 |
result.contactAddresses.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
result.contactAddresses.levelNumberEnd | string | The ending level number (floor number) that makes up the address within a complex. | 7.3.3.4 |
result.contactAddresses.levelNumberStart | string | The beginning level number (floor number) that makes up the address within a complex. | 7.3.3.4 |
result.contactAddresses.levelPrefix | string | The prefix for the level numbers (floor numbers) that make up the address. | 7.3.3.4 |
result.contactAddresses.phone | string | The telephone number of the contact. | 7.3.3.4 |
result.contactAddresses.phoneCountryCode | string | The country code for the associated phone number. | 7.3.3.4 |
result.contactAddresses.postalCode | string | The postal ZIP code for the address. | 7.3.3.4 |
result.contactAddresses.primary | string | � | 7.3.3.4 |
result.contactAddresses.recipient | string | The entity on the receiving end of an operation, for example a notification of an event. | 7.3.3.4 |
result.contactAddresses.state | result.contactAddresses.state{} | The state corresponding to the address on record. | 7.3.3.4 |
result.contactAddresses.state.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.state.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.status | result.contactAddresses.status{} | The contact address status. | 7.3.3.4 |
result.contactAddresses.streetDirection | result.contactAddresses.streetDirection{} | 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.3.4 |
result.contactAddresses.streetDirection.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.streetDirection.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.streetName | string | The street name for the address. | 7.3.3.4 |
result.contactAddresses.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.3.4 |
result.contactAddresses.streetSuffix | result.contactAddresses.streetSuffix{} | The type of street such as "Lane" or "Boulevard". | 7.3.3.4 |
result.contactAddresses.streetSuffix.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.streetSuffix.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.streetSuffixDirection | result.contactAddresses.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.3.4 |
result.contactAddresses.streetSuffixDirection.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.streetSuffixDirection.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.type | result.contactAddresses.type{} | The address type. | 7.3.3.4 |
result.contactAddresses.type.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.type.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.unitEnd | string | The end parameter of a range of unit numbers. | 7.3.3.4 |
result.contactAddresses.unitStart | string | The starting parameter of a range of unit numbers. | 7.3.3.4 |
result.contactAddresses.unitType | result.contactAddresses.unitType{} | The unit type designation of the address. | 7.3.3.4 |
result.contactAddresses.unitType.text | string | The localized display text. | 7.3.3.4 |
result.contactAddresses.unitType.value | string | The value for the specified parameter. | 7.3.3.4 |
result.contactAddresses.validateFlag | string | � | 7.3.3.4 |
result.deceasedDate | dateTime | The date of death. This field is active only when the Contact Type selected is Individual. | 7.3.3.4 |
result.driverLicenseNumber | string | The driver's license number of the contact. This field is active only when the Contact Type selected is Individual. | 7.3.3.4 |
result.driverLicenseState | result.driverLicenseState{} | The state that issued the driver's license. | 7.3.3.4 |
result.driverLicenseState.text | string | The localized display text. | 7.3.3.4 |
result.driverLicenseState.value | string | The value for the specified parameter. | 7.3.3.4 |
result.email | string | The contact's email address. | 7.3.3.4 |
result.faxCountryCode | string | Fax Number Country Code | 7.3.3.4 |
result.faxNumber | string | The user's fax number. | 7.3.3.4 |
result.federalEmployerId | string | The Federal Employer Identification Number. It is used to identify a business for tax purposes. | 7.3.3.4 |
result.firstName | string | The contact's first name. This field is only active when the Contact Type selected is Individual. | 7.3.3.4 |
result.fullName | string | The contact's full name. This field is only active when the Contact Type selected is Individual. | 7.3.3.4 |
result.gender | result.gender{} | The gender (male or female) of the individual. | 7.3.3.4 |
result.gender.text | string | The localized display text. | 7.3.3.4 |
result.gender.value | string | The value for the specified parameter. | 7.3.3.4 |
result.id | string | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
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.3.4 |
result.lastName | string | The last name (surname). | 7.3.3.4 |
result.middleName | string | The middle name. | 7.3.3.4 |
result.namesuffix | string | The suffix that follows the user's name. | 7.3.3.4 |
result.passportNumber | string | The contact's passport number. This field is only active when the Contact Type selected is Individual. | 7.3.3.4 |
result.phone1CountryCode | string | Phone Number 1 Country Code | 7.3.3.4 |
result.phone2CountryCode | string | Phone Number 2 Country Code | 7.3.3.4 |
result.phone3CountryCode | string | Phone Number 3 Country Code | 7.3.3.4 |
result.phoneNumber1 | string | The user's first phone number. | 7.3.3.4 |
result.phoneNumber2 | string | The user's second phone number. | 7.3.3.4 |
result.phoneNumber3 | string | The user's third phone number. | 7.3.3.4 |
result.postOfficeBox | string | The post office box number. | 7.3.3.4 |
result.preferredChannel | result.preferredChannel{} | The method by which the contact prefers to be notified, by phone for example. | 7.3.3.4 |
result.preferredChannel.text | string | The localized display text. | 7.3.3.4 |
result.preferredChannel.value | string | The value for the specified parameter. | 7.3.3.4 |
result.race | result.race{} | The contact's race/ethnicity. | 7.3.3.4 |
result.race.text | string | The localized display text. | 7.3.3.4 |
result.race.value | string | The value for the specified parameter. | 7.3.3.4 |
result.relation | result.relation{} | The contact's relationship to the application or service request. | 7.3.3.4 |
result.relation.text | string | The localized display text. | 7.3.3.4 |
result.relation.value | string | The value for the specified parameter. | 7.3.3.4 |
result.salutation | result.salutation{} | The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual. | 7.3.3.4 |
result.salutation.text | string | The localized display text. | 7.3.3.4 |
result.salutation.value | string | The value for the specified parameter. | 7.3.3.4 |
result.socialSecurityNumber | string | The individual's social security number. This field is only active when the Contact Type selected is Individual. | 7.3.3.4 |
result.stateIdNumber | string | The contact's state ID number. This field is only active when the Contact Type selected is Individual. | 7.3.3.4 |
result.status | result.status{} | The contact status. | 7.3.3.4 |
result.title | string | The individual's business title. | 7.3.3.4 |
result.tradeName | string | The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization. | 7.3.3.4 |
result.type | result.type{} | The type of people to contact. | 7.3.3.4 |
result.type.text | string | The localized display text. | 7.3.3.4 |
result.type.value | string | The value for the specified parameter. | 7.3.3.4 |
result.typeFlag | string | � | 7.3.3.4 |
status | integer | The record status. | 7.3.3.4 |