Jump to

• Request
• Response

Get a parcel address for the associated application

get

/fscmRestApi/resources/11.13.18.05/publicSectorApplicationLists/{LnpRecordKey}/child/ParcelAddress/{AddressKey}

Request

Path Parameters

• AddressKey(required): integer(int64)
  The unique identifier of the parcel address.
• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorApplicationLists-ParcelAddress-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first or main address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second address, if present.
• Address3: string
  Title: Address Line 3

  Maximum Length: 240

  The third address, if present.
• Address4: string
  Title: Address Line 4

  Maximum Length: 240

  The fourth address, if present.
• AddressId: integer (int64)
  Title: Address

  The identifier of the parcel address.
• AddressKey: integer (int64)
  Title: Address Key

  The unique identifier of the parcel address.
• AddressType: string
  Title: Address Type

  Maximum Length: 20

  The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier of the agency.
• BuildingType: string
  Title: Building

  Maximum Length: 20

  The type of building used in an address search. For example, Tower A or Block 3.
• CellPhoneCountry: string
  Title: Cell Phone Country

  Maximum Length: 10

  The country code for the cell phone number of parcel contact.
• CellPhoneNumber: string
  Title: Cell Phone

  Maximum Length: 40

  The cell phone number of the parcel address contact.
• City: string
  Title: City

  Maximum Length: 60

  The city in the parcel address.
• CoordinateX: number
  Title: Coordinate X

  The x-axis coordinate of the record parcel address.
• CoordinateY: number
  Title: Coordinate Y

  The y-axis coordinate of the record parcel address.
• Country: string
  Title: Country

  Maximum Length: 60

  The country in the parcel address.
• County: string
  Title: County

  Maximum Length: 60

  The country in the parcel address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the parcel address was created.
• CrossroadOne: string
  Maximum Length: 240

  The first cross road of the intersection.
• CrossroadTwo: string
  Maximum Length: 240

  The second cross road of the intersection.
• EmailId: string
  Title: Email

  Maximum Length: 50

  The email address of the parcel address contact.
• FaxCountry: string
  Title: Fax Country

  Maximum Length: 10

  The country code for the fax number of the parcel contact.
• FaxNumber: string
  Title: Fax

  Maximum Length: 40

  The fax number of the parcel address contact.
• Floor: string
  Title: Floor

  Maximum Length: 20

  The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.
• HomePhoneCountry: string
  Title: Home Phone Country

  Maximum Length: 10

  The country code for the home telephone number of the parcel address contact.
• HomePhoneNumber: string
  Title: Home Phone

  Maximum Length: 40

  The home telephone number of the parcel address contact.
• InputSource: string
  Title: Source

  Maximum Length: 1

  Indicates how the data was entered or loaded into the application. The values are S for system data and U for user-entered data.
• Landmark: string
  Maximum Length: 200

  The landmark associated with the address.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the parcel address was last updated.
• Latitude: number
  Title: Latitude

  The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50

  A logical identifier for the application record.
• LnpRecordKey: integer (int64)
  Title: Record

  The unique identifier of the record associated with the parcel address.
• Longitude: number
  Title: Longitude

  The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• MunicipalityId: string
  Title: Municipality

  Maximum Length: 20

  The municipality identifier if the parcel is not managed at the county level.
• ParcelId: integer (int64)
  Title: Parcel

  The identifier of the record parcel.
• ParcelKey: integer (int64)
  Title: Parcel Key

  The unique identifier of the parcel associated with a parcel address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code in the parcel address.
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20

  An extended postal code in the parcel address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N.
• PrimaryTransAddress: boolean
  Title: Primary Transaction Address

  Maximum Length: 1

  Indicates the primary address for the transaction. If the value is 'Y' then the address is the primary transaction address. The default value is N.
• Province: string
  Title: Province

  Maximum Length: 60

  The province in the parcel address.
• Srid: integer (int64)
  Title: SRID

  The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems.
• State: string
  Title: State

  Maximum Length: 60

  The state in the parcel address.
• StreetDirection: string
  Title: Direction

  Maximum Length: 10

  The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.
• StreetName: string
  Title: Street

  Maximum Length: 240

  The street name in the parcel address used during a search.
• StreetNameConcat: string
  Maximum Length: 350

  The concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.
• StreetNumber: string
  Title: Street Number

  Maximum Length: 20

  The street number in the parcel address.
• StreetSuffix: string
  Maximum Length: 20

  The street suffix that further describes that street like Drive, Avenue, and others.
• StreetType: string
  Title: Street Type

  Maximum Length: 20

  The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber: string
  Title: Unit

  Maximum Length: 30

  The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.
• WorkPhoneCountry: string
  Title: Work Phone Country

  Maximum Length: 10

  The country code for the work telephone number of the parcel contact.
• WorkPhoneNumber: string
  Title: Work Phone

  Maximum Length: 40

  The work telephone number of the parcel address contact.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street",
            "maxLength":"240",
            "type":"string",
            "description":"The street name in the parcel address used during a search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the parcel address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneNumber":{
            "title":"Cell Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The cell phone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the cell phone number of parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "InputSource":{
            "title":"Source",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates how the data was entered or loaded into the application. The values are S for system data and U for user-entered data.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the fax number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryTransAddress":{
            "title":"Primary Transaction Address",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the primary address for the transaction. If the value is 'Y' then the address is the primary transaction address. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetSuffix":{
            "maxLength":"20",
            "type":"string",
            "description":"The street suffix that further describes that street like Drive, Avenue, and others.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossroadOne":{
            "maxLength":"240",
            "type":"string",
            "description":"The first cross road of the intersection.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNameConcat":{
            "maxLength":"350",
            "type":"string",
            "description":"The concatenated value of the street name corresponding to the parcel address. The concatenated value of the street name is obtained by concatenating direction prefix, street name, street suffix and direction suffix.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building",
            "maxLength":"20",
            "type":"string",
            "description":"The type of building used in an address search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the work telephone number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":"40",
            "type":"string",
            "description":"The fax number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "title":"Parcel Key",
            "type":"integer",
            "description":"The unique identifier of the parcel associated with a parcel address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address",
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":"50",
            "type":"string",
            "description":"The email address of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Landmark":{
            "maxLength":"200",
            "type":"string",
            "description":"The landmark associated with the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressKey":{
            "title":"Address Key",
            "type":"integer",
            "description":"The unique identifier of the parcel address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The street type designation used during a search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier of the record associated with the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"20",
            "type":"string",
            "description":"An extended postal code in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Direction",
            "maxLength":"10",
            "type":"string",
            "description":"The street direction in an address search. Values are compass directions, such as N, S, E, W, NW, SE, and so on. For example, they can be used to find all parcels with an address that is north of the city center.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"60",
            "type":"string",
            "description":"The country in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "maxLength":"30",
            "type":"string",
            "description":"The exact unit in a building used in an address search. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"Coordinate X",
            "type":"number",
            "description":"The x-axis coordinate of the record parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Coordinate Y",
            "type":"number",
            "description":"The y-axis coordinate of the record parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The work telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The country in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"A logical identifier for the application record.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":"20",
            "type":"string",
            "description":"The floor or level in an address search. For example, mezzanine level, penthouse, or garage level C.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossroadTwo":{
            "maxLength":"240",
            "type":"string",
            "description":"The second cross road of the intersection.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "x-queryable":true
        },
        "MunicipalityId":{
            "title":"Municipality",
            "maxLength":"20",
            "type":"string",
            "description":"The municipality identifier if the parcel is not managed at the county level.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country",
            "maxLength":"10",
            "type":"string",
            "description":"The country code for the home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":"20",
            "type":"string",
            "description":"The address type used for delivery point validation (DPV). For example, main address, side address, or virtual address.",
            "nullable":true,
            "x-queryable":true
        },
        "Srid":{
            "title":"SRID",
            "type":"integer",
            "description":"The SRID of the parcel address. This attribute indicates the Spatial Reference System Identifier (SRID), which is a unique value that identifies projected, unprojected, and local spatial coordinate system definitions. Used in all GIS systems.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"10"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the parcel address was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top