Search Owners by Owner

Returns owners that match the specified owner fields.

Get Owners by Owner Keys is equivalent to the legacy Accela GIS SOAP API getOwnerBySearchKeys.

For an overview, see Owners.

URI

POST /api/geo/v1/xapo/{agencyId}/owners/byOwner

Request JSON Syntax

{
 "owner" :
 {
 "UID": "string",
 "address": "string",
 "address1": "string",
 "address2": "string",
 "address3": "string",
 "auditDate": "string",
 "auditID": "string",
 "auditStatus": "string",
 "city": "string",
 "country": "string",
 "email": "string",
 "eventID": "string",
 "fax": "string",
 "faxCountryCode": "string",
 "isPrimary": "string",
 "ivrPinNumber": "string",
 "ivrUserNumber": "string",
 "mailAddress": "string",
 "mailAddress1": "string",
 "mailAddress2": "string",
 "mailAddress3": "string",
 "mailCity": "string",
 "mailCountry": "string",
 "mailState": "string",
 "mailZip": "string",
 "ownerFirstName": "string",
 "ownerFullName": "string",
 "ownerLastName": "string",
 "ownerMiddleName": "string",
 "ownerStatus": "string",
 "ownerTitle": "string",
 "phone": "string",
 "phoneCountryCode": "string",
 "sourceSeqNumber": "string",
 "state": "string",
 "taxID": "string",
 "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
 },
 "settings":
 {
 "maxRows": "int",
 "startRow": "int",
 "orderBy": "string"
 }
}

Response JSON Syntax

{
 "result":
 [
  {
 "UID": "string",
 "address": "string",
 "address1": "string",
 "address2": "string",
 "address3": "string",
 "auditDate": "string",
 "auditID": "string",
 "auditStatus": "string",
 "city": "string",
 "country": "string",
 "email": "string",
 "eventID": "string",
 "fax": "string",
 "faxCountryCode": "string",
 "isPrimary": "string",
 "ivrPinNumber": "string",
 "ivrUserNumber": "string",
 "mailAddress": "string",
 "mailAddress1": "string",
 "mailAddress2": "string",
 "mailAddress3": "string",
 "mailCity": "string",
 "mailCountry": "string",
 "mailState": "string",
 "mailZip": "string",
 "ownerFirstName": "string",
 "ownerFullName": "string",
 "ownerLastName": "string",
 "ownerMiddleName": "string",
 "ownerStatus": "string",
 "ownerTitle": "string",
 "phone": "string",
 "phoneCountryCode": "string",
 "sourceSeqNumber": "string",
 "state": "string",
 "taxID": "string",
 "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
 },
 {
 "UID": "string",
 "address": "string",
 "address1": "string",
 "address2": "string",
 "address3": "string",
 "auditDate": "string",
 "auditID": "string",
 "auditStatus": "string",
 "city": "string",
 "country": "string",
 "email": "string",
 "eventID": "string",
 "fax": "string",
 "faxCountryCode": "string",
 "isPrimary": "string",
 "ivrPinNumber": "string",
 "ivrUserNumber": "string",
 "mailAddress": "string",
 "mailAddress1": "string",
 "mailAddress2": "string",
 "mailAddress3": "string",
 "mailCity": "string",
 "mailCountry": "string",
 "mailState": "string",
 "mailZip": "string",
 "ownerFirstName": "string",
 "ownerFullName": "string",
 "ownerLastName": "string",
 "ownerMiddleName": "string",
 "ownerStatus": "string",
 "ownerTitle": "string",
 "phone": "string",
 "phoneCountryCode": "string",
 "sourceSeqNumber": "string",
 "state": "string",
 "taxID": "string",
 "zip": "string",
  "userDefinedFields": [
     {
       "fieldName":"string",
       "fieldValue":"string"
     },
     {
       "fieldName":"string",
       "fieldValue":"string"
     }
  ]
 }
 ],
  "totalRecords": "int"
}

Request Field Descriptions

Parameter	Type	Required	Description
agencyId	String	Yes	The required agency parameter. The XAPO field mapping must be configured for the requested agency on the GIS Admin site.
owner	owner { }	Yes	The owner JSON object containing owner request parameters.
owner.UID	String	No	A unique identifier for the external owner
owner.address	String	No	The Address field from the Reference Owner List
owner.address1	String	No	The first line of the owner's address
owner.address2	String	No	The second line of the owner's address
owner.address3	String	No	The third line of the owner's address
owner.auditDate	Date	Yes	The creation date or modification date of the owner record
owner.auditID	String	Yes	The identification code of the person who created or modified the owner record
owner.auditStatus	String	No	A single character code representing audit status
owner.city	String	No	The city in which the owner lives
owner.country	String	No	The country in which the owner lives
owner.email	String	No	The owner’s email address
owner.eventID	String	No	Any event scheduled for this owner
owner.fax	String	No	The owner’s fax number
owner.faxCountryCode	String	No	The three character code indicating the fax country. In Accela Automation, you enable the fax country codes through the `PHONE_NUMBER_IDD_ENABLE` standard choice.
owner.isPrimary	String	No	Is Primary
owner.ivrPinNumber		No	The user’s IVR Pin Number
owner.ivrUserNumber		No	The automatically generated IVR user number
owner.mailAddress		No
owner.mailAddress1	String	No	The first line of the owner’s mailing address
owner.mailAddress2	String	No	The second line of the owner’s mailing address
owner.mailAddress3	String	No	The third line of the owner’s mailing address
owner.mailCity	String	No	The city of the owner’s mailing address
owner.mailCountry	String	No	The country of the owner’s mailing address
owner.mailState	String	No	The state of the owner’s mailing address
owner.mailZip	String	No	The zip code of the owner’s mailing address
owner.ownerFirstName	String	No	The owner’s first name
owner.ownerFullName	String	No	The owner’s full name
owner.ownerLastName	String	No	The owner’s last name
owner.ownerMiddleName	String	No	The owner’s middle name
owner.ownerStatus	String	No	The status of the owner, either disabled (I) or enabled (A)
owner.ownerTitle	String	No	The owner’s title
owner.phone	String	No	The owner's daytime telephone number
owner.phoneCountryCode	String	No	The three character code indicating the phone country. In Accela Automation, you enable the phone country codes through the `PHONE_NUMBER_IDD_ENABLE` standard choice.
owner.sourceSeqNumber	NA	No	The ID number that you use to identify the owner in the external APO database
owner.state	String	No	The configured state name in which the address exists
owner.taxID	String	No	The owner’s tax ID
owner.zip	String	No	The zip code for the owner’s address
owner.userDefinedFields	Array	No	Contains owner template custom fields
owner.userDefinedFields.fieldName	String	No	A custom field name
owner.userDefinedFields.fieldValue	String	No	A custom field value

Parameter	Type	Required	Description
settings	settings { }	No	The settings object containing settings request parameters.
settings.maxRows	integer	No	The maximum number of rows to be returned. Note: If the search results are greater than the feature count limit configured on GIS Administration > XAPO Configuration, the API returns an error indicating the exceeded feature count limit. In this case, the API caller should re-submit the query with a narrower criteria or set the maxRows page setting to a number less than the feature count limit.
settings.startRow	integer	No	The 1-based row index of the first record to be returned.
settings.orderBy	String	No	The returned rows will be sorted by the specified field(s) in the specified order. The format is `<field> <order>`, where `<order>` is either `ASC` for ascending or `DESC` for descending order. The default order is ascending. To specify multiple fields, use the format: `<field1> <order>, <fieldN> <order>` For example: `"streetName ASC,houseNumberStart DESC"`

Response Field Descriptions

Parameter	Type	Description
owners [ ]	owners{ }	An array containing the result owners.
owners.UID	String	A unique identifier for the external owner
owners.address	String	The Address field from the Reference Owner List
owners.address1	String	The first line of the owner's address
owners.address2	String	The second line of the owner's address
owners.address3	String	The third line of the owner's address
owners.auditDate	Date	The creation date or modification date of the owner record
owners.auditID	String	The identification code of the person who created or modified the owner record
owners.auditStatus	String	A single character code representing audit status
owners.city	String	The city in which the owner lives
owners.country	String	The country in which the owner lives
owners.email	String	The owner’s email address
owners.eventID	String	Any event scheduled for this owner
owners.fax	String	The owner’s fax number
owners.faxCountryCode	String	The three character code indicating the fax country. In Accela Automation, you enable the fax country codes through the PHONE_NUMBER_IDD_ENABLE standard choice.
owners.isPrimary	String	Is Primary
owners.ivrPinNumber	String	The user’s IVR Pin Number
owners.ivrUserNumber	String	The automatically generated IVR user number
owners.mailAddress	String	The mailing address
owners.mailAddress1	String	The first line of the owner’s mailing address
owners.mailAddress2	String	The second line of the owner’s mailing address
owners.mailAddress3	String	The third line of the owner’s mailing address
owners.mailCity	String	The city of the owner’s mailing address
owners.mailCountry	String	The country of the owner’s mailing address
owners.mailState	String	The state of the owner’s mailing address
owners.mailZip	String	The zip code of the owner’s mailing address
owners.ownerFirstName	String	The owner’s first name
owners.ownerFullName	String	The owner’s full name
owners.ownerLastName	String	The owner’s last name
owners.ownerMiddleName	String	The owner’s middle name
owners.ownerStatus	String	The status of the owner, either disabled (I) or enabled (A)
owners.ownerTitle	String	The owner’s title
owners.phone	String	The owner's daytime telephone number
owners.phoneCountryCode	String	The three character code indicating the phone country. In Accela Automation, you enable the phone country codes through the PHONE_NUMBER_IDD_ENABLE standard choice.
owners.sourceSeqNumber	NA	The ID number that you use to identify the owner in the external APO database
owners.state	String	The configured state name in which the address exists
owners.taxID	String	The owner’s tax ID
owners.zip	String	The zip code for the owner’s address
owners.userDefinedFields	Array	Contains owner template custom fields
owners.userDefinedFields.fieldName	String	A custom field name
owners.userDefinedFields.fieldValue	String	A custom field value
totalRecords	integer	The total number of records that match the search criteria

Sample Request

The following example searches an owner.

http://[GISBASEURL]/agis/api/geo/v1/xapo/flagstaff/owners/byOwner

Sample request body:

{
            "owner" :
            {
            "ownerfullname":"Saland",	
            "ownerlastname":"David",	
            "ownermiddlename":"K"	
            }
            }

Sample Response

{
  "result": [
    {
      "UID": "006423031",
      "address": " ",
      "eventID": "10867",
      "ivrPinNumber": "006",
      "ownerFirstName": "SALAND",
      "ownerFullName": "SALAND",
      "ownerLastName": "DAVID",
      "ownerMiddleName": "K",
      "phone": "42",
      "taxID": "006423031"
    },
    {
      "UID": "006433008",
      "address": " ",
      "eventID": "11429",
      "ivrPinNumber": "006",
      "ownerFirstName": "SALAND",
      "ownerFullName": "SALAND",
      "ownerLastName": "DAVID",
      "ownerMiddleName": "K",
      "phone": "43",
      "taxID": "006433008"
    },
    {
      "UID": "006433006",
      "address": " ",
      "eventID": "11800",
      "ivrPinNumber": "006",
      "ownerFirstName": "SALAND",
      "ownerFullName": "SALAND",
      "ownerLastName": "DAVID",
      "ownerMiddleName": "K",
      "phone": "43",
      "taxID": "006433006"
    },
    {
      "UID": "007441015",
      "address": " ",
      "eventID": "12425",
      "ivrPinNumber": "007",
      "ownerFirstName": "SALAND",
      "ownerFullName": "SALAND",
      "ownerLastName": "DAVID",
      "ownerMiddleName": "K",
      "phone": "44",
      "taxID": "007441015"
    }
  ],
  "totalRecords": 4
}