Jump to

• Request
• Response

Get a parcel address

get

/fscmRestApi/resources/11.13.18.05/publicSectorParcelAddresses/{publicSectorParcelAddressesUniqID}

Request

Path Parameters

• publicSectorParcelAddressesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AddressId and ParcelId ---for the Parcel Addresses resource and used to uniquely identify an instance of Parcel Addresses. The client should not generate the hash key value. Instead, the client should query on the Parcel Addresses collection resource with a filter on the primary key values in order to navigate to a specific instance of Parcel Addresses.
  
  For example: publicSectorParcelAddresses?q=AddressId=<value1>;ParcelId=<value2>

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

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

  The first line of the parcel address.
• Address2: string
  Title: Address Line 2

  Maximum Length: 240

  The second line of the parcel address.
• Address3: string
  Title: Address Line 3

  Read Only: true

  Maximum Length: 240

  The third line of the parcel address.
• Address4: string
  Title: Address Line 4

  Read Only: true

  Maximum Length: 240

  The fourth line of the parcel address.
• AddressCode: string
  Maximum Length: 480

  The address code of the parcel address.
• AddressId: integer (int64)
  Title: Address ID

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

  Read Only: true

  Maximum Length: 20

  The type of the parcel address.
• BuildingType: string
  Title: Address Type

  Maximum Length: 20

  The building type of the parcel address.
• CellPhoneCountry: string
  Title: Cell Phone Country Code

  Read Only: true

  Maximum Length: 10

  The cell phone country code of the parcel address.
• CellPhoneNumber: string
  Title: Cell Phone Number

  Maximum Length: 40

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

  Maximum Length: 60

  The city of the parcel address.
• CoordinateX: number
  The x coordinate of the parcel address.
• CoordinateY: number
  The y coordinate of the parcel address.
• Country: string
  Title: Country

  Maximum Length: 3

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

  Maximum Length: 60

  The county of the parcel address.
• CrossroadOne: string
  Title: Crossroad

  Maximum Length: 240

  The first crossroad of the intersection.
• CrossroadTwo: string
  Title: Crossroad 2

  Maximum Length: 240

  The second crossroad of the intersection.
• EmailId: string
  Title: Email Address

  Maximum Length: 50

  The email address of the parcel address.
• EnabledFlag: boolean
  Maximum Length: 1

  Indicates whether the parcel address is available to be used.
• FaxCountry: string
  Title: Fax Country Code

  Read Only: true

  Maximum Length: 10

  The fax country code of the parcel address.
• FaxNumber: string
  Title: Fax Number

  Maximum Length: 40

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

  Maximum Length: 20

  The floor the parcel address is on.
• HomePhoneCountry: string
  Title: Home Phone Country Code

  Read Only: true

  Maximum Length: 10

  The home phone country code of the parcel address.
• HomePhoneNumber: string
  Title: Home Phone Number

  Maximum Length: 40

  The home phone number of the parcel address.
• InputSource: string
  Maximum Length: 1

  The input source of the parcel address.
• Landmark: string
  Title: Landmark

  Maximum Length: 200

  The landmark associated with the address.
• Latitude: number
  The latitude of the parcel address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  The longitude of the parcel address.
• MunicipalityId: string
  Read Only: true

  Maximum Length: 20

  The unique identifier for the municipality of the parcel address.
• Name: string
  Title: Name 1

  Maximum Length: 150

  The name of the first contact person.
• ParcelId: integer (int64)
  The unique identifier for the parcel.
• ParcelIdEntered: string
  Title: Parcel Number

  Maximum Length: 50

  The parcel number.
• ParcelNumber: string
  Title: Parcel Number

  Read Only: true

  Maximum Length: 50

  The parcel associated with the address.
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60

  The postal code of the parcel address.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 10

  The postal plus 4 code of the parcel address.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates whether the parcel address is marked as primary for that parcel.
• Province: string
  Read Only: true

  Maximum Length: 60

  The province of the parcel address.
• SecondaryName: string
  Title: Name 2

  Maximum Length: 150

  The name of the second contact person.
• Srid: integer (int64)
  Read Only: true

  The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.
• State: string
  Title: State

  Maximum Length: 60

  The state of the parcel address.
• StreeName: string
  Title: Street Name

  Maximum Length: 240

  The street name of the parcel address.
• StreetDirection: string
  Title: Direction Prefix

  Maximum Length: 10

  The street direction of the parcel address.
• StreetNameConcat: string
  Read Only: true

  Maximum Length: 350

  Indicates 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 of the parcel address.
• StreetNumberAlpha: string
  Read Only: true

  Maximum Length: 20

  Indicates the alphabetic portion of the street number in the parcel address.
• StreetNumberNumeric: integer (int64)
  Read Only: true

  Indicates the numerical portion of the street number in the parcel address.
• StreetSuffix: string
  Title: Direction Suffix

  Maximum Length: 20

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

  Maximum Length: 20

  The street type of the parcel address.
• UnitNumber: string
  Title: Unit

  Maximum Length: 30

  The unit number of the parcel address.
• WorkPhoneCountry: string
  Title: Work Phone Country Code

  Read Only: true

  Maximum Length: 10

  The work phone country code of the parcel address.
• WorkPhoneNumber: string
  Title: Work Phone Number

  Maximum Length: 40

  The work phone number of the parcel address.

{
    "type":"object",
    "properties":{
        "CellPhoneNumber":{
            "title":"Cell Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The cell phone country code of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputSource":{
            "maxLength":1,
            "type":"string",
            "description":"The input source of the parcel address.",
            "nullable":false,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The fax country code of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNameConcat":{
            "maxLength":350,
            "type":"string",
            "description":"Indicates 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,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetSuffix":{
            "title":"Direction Suffix",
            "maxLength":20,
            "type":"string",
            "description":"The streeet suffix that further describes that street like Drive, Avenue etc.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossroadOne":{
            "title":"Crossroad",
            "maxLength":240,
            "type":"string",
            "description":"The first crossroad of the intersection.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name 1",
            "maxLength":150,
            "type":"string",
            "description":"The name of the first contact person.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Address Type",
            "maxLength":20,
            "type":"string",
            "description":"The building type of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The work phone country code of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax Number",
            "maxLength":40,
            "type":"string",
            "description":"The fax phone number of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The parcel number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":20,
            "type":"string",
            "description":"The street number of 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"
            }
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The unique identifier for the parcel address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":50,
            "type":"string",
            "description":"The email address of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Landmark":{
            "title":"Landmark",
            "maxLength":200,
            "type":"string",
            "description":"The landmark associated with the address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressCode":{
            "maxLength":480,
            "type":"string",
            "description":"The address code of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Suffix",
            "maxLength":20,
            "type":"string",
            "description":"The street type of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus 4 code of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryName":{
            "title":"Name 2",
            "maxLength":150,
            "type":"string",
            "description":"The name of the second contact person.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Direction Prefix",
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "type":"number",
            "description":"The x coordinate of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "type":"number",
            "description":"The y coordinate of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumberAlpha":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates the alphabetic portion of the street number in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the parcel address is marked as primary for that parcel.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the parcel address.",
            "nullable":false,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreeName":{
            "title":"Street Name",
            "maxLength":240,
            "type":"string",
            "description":"The street name of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumberNumeric":{
            "type":"integer",
            "description":"Indicates the numerical portion of the street number in the parcel address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":20
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the parcel address is available to be used.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelNumber":{
            "title":"Parcel Number",
            "maxLength":50,
            "type":"string",
            "description":"The parcel associated with the address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier for the parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":20,
            "type":"string",
            "description":"The floor the parcel address is on.",
            "nullable":true,
            "x-queryable":true
        },
        "CrossroadTwo":{
            "title":"Crossroad 2",
            "maxLength":240,
            "type":"string",
            "description":"The second crossroad of the intersection.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third line of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel address.",
            "nullable":false,
            "x-queryable":true
        },
        "MunicipalityId":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the municipality of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The home phone country code of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddressType":{
            "title":"Address Type",
            "maxLength":20,
            "type":"string",
            "description":"The type of the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Srid":{
            "type":"integer",
            "description":"The spatial reference identifier. This is a unique coordinate identifier for a local, regional, or global system used to locate geographical or spatial entities within geographic information systems.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":10
            },
            "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