Jump to

• Request
• Response

Get all record parcels with their parcel addresses

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordParcelAddressCrosses

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a parcel and its address using the primary key criteria.
    Finder Variables:
    • AddressKey; integer; The unique identifier for a parcel address.
    • ParcelKey; integer; The unique identifier for a parcel.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The first or main address.
  • Address2; string; The second address, if present.
  • Address3; string; The third address, if present.
  • Address4; string; The fourth address, if present.
  • AddressId; integer; The identifier of the parcel address.
  • AddressKey; integer; The unique identifier of the parcel address.
  • AddressPrimaryFlag; boolean; Indicates the primary parcel address. If the value is Y, then the parcel address is the primary parcel address. The default value is N.
  • City; string; The city in the parcel address.
  • CoordinateX; number; The x-axis coordinate of the record parcel address.
  • CoordinateY; number; The y-axis coordinate of the record parcel address.
  • Country; string; The country in the parcel address.
  • County; string; The county in the parcel address.
  • CreationDate; string; The date when the record parcel was created.
  • LastUpdateDate; string; The user who last updated the record parcel.
  • Latitude; number; 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.
  • LnpRecordId; string; The unique identifier for the application record.
  • LnpRecordKey; integer; The unique identifier for the record associated with the parcel.
  • Longitude; number; 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.
  • ParcelId; integer; The identifier of the record parcel.
  • ParcelIdEntered; string; The Assessor Parcel Number (APN) as entered by the user.
  • ParcelKey; integer; The unique identifier for a parcel.
  • ParcelLatitude; number; The geographic location of the parcel that is north or south of the equator.
  • ParcelLongitude; number; The geographic location of the parcel address that is east or west of the meridian.
  • PostalCode; string; The postal code in the parcel address.
  • PrimaryFlag; boolean; Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.
  • PrimaryTransAddress; boolean; 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; The province in the parcel address.
  • State; string; The state in the parcel address.
  • StreetDirection; string; 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; The street name in the parcel address.
  • StreetNumber; string; The street number in the parcel address.
  • StreetSuffix; string; The street suffix that further describes that street like Drive, Avenue etc.
  • StreetType; string; The street type designation. For example, alley, boulevard, avenue, lane, street, loop, and so on.
  • UnitNumber; string; The exact unit in a building. For example, Apartment 208A or Suite 300.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : publicSectorRecordParcelAddressCrosses

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordParcelAddressCrosses-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Permits",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRecordParcelAddressCrosses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordParcelAddressCrosses-item-response"
    }
}

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 : publicSectorRecordParcelAddressCrosses-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first or main address.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second address, if present.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third address, if present.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth address, if present.
• AddressId: integer (int64)
  Read Only: true

  The identifier of the parcel address.
• AddressKey: integer (int64)
  Read Only: true

  The unique identifier of the parcel address.
• AddressPrimaryFlag: boolean
  Read Only: true

  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.
• City: string
  Read Only: true

  Maximum Length: 60

  The city in the parcel address.
• CoordinateX: number
  Read Only: true

  The x-axis coordinate of the record parcel address.
• CoordinateY: number
  Read Only: true

  The y-axis coordinate of the record parcel address.
• Country: string
  Read Only: true

  Maximum Length: 3

  The country in the parcel address.
• County: string
  Read Only: true

  Maximum Length: 5

  The county in the parcel address.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record parcel was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the record parcel.
• Latitude: number
  Read Only: true

  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
  Read Only: true

  Maximum Length: 50

  The unique identifier for the application record.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for the record associated with the parcel.
• Longitude: number
  Read Only: true

  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.
• ParcelId: integer (int64)
  Read Only: true

  The identifier of the record parcel.
• ParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The Assessor Parcel Number (APN) as entered by the user.
• ParcelKey: integer
  Read Only: true

  The unique identifier for a parcel.
• ParcelLatitude: number
  Read Only: true

  The geographic location of the parcel that is north or south of the equator.
• ParcelLongitude: number
  Read Only: true

  The geographic location of the parcel address that is east or west of the meridian.
• PostalCode: string
  Read Only: true

  Maximum Length: 20

  The postal code in the parcel address.
• PrimaryFlag: boolean
  Read Only: true

  Maximum Length: 1

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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 60

  The province in the parcel address.
• State: string
  Read Only: true

  Maximum Length: 6

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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 240

  The street name in the parcel address.
• StreetNumber: string
  Title: Street Number

  Read Only: true

  Maximum Length: 20

  The street number in the parcel address.
• StreetSuffix: string
  Title: Suffix

  Read Only: true

  Maximum Length: 20

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

  Read Only: true

  Maximum Length: 20

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

  Read Only: true

  Maximum Length: 30

  The exact unit in a building. For example, Apartment 208A or Suite 300.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street",
            "maxLength":"240",
            "type":"string",
            "description":"The street name in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record parcel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the primary parcel. If the value is Y, then the parcel is the primary parcel. The default value is N.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal code in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"5",
            "type":"string",
            "description":"The county in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetSuffix":{
            "title":"Suffix",
            "maxLength":"20",
            "type":"string",
            "description":"The street suffix that further describes that street like Drive, Avenue etc.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The Assessor Parcel Number (APN) as entered by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":"20",
            "type":"string",
            "description":"The street number in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The unique identifier for a parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the application record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelLatitude":{
            "type":"number",
            "description":"The geographic location of the parcel that is north or south of the equator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The unique identifier of the parcel address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"60",
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"20",
            "type":"string",
            "description":"The street type designation. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record associated with the parcel.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "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,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressPrimaryFlag":{
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":"6",
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelLongitude":{
            "type":"number",
            "description":"The geographic location of the parcel address that is east or west of the meridian.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"3",
            "type":"string",
            "description":"The country in the parcel address.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "maxLength":"30",
            "type":"string",
            "description":"The exact unit in a building. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "type":"number",
            "description":"The x-axis coordinate of the record parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "type":"number",
            "description":"The y-axis coordinate of the record parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the record parcel.",
            "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