Jump to

• Request
• Response

Get a project parcel address

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectAddresses/{AddressKey}

Request

Path Parameters

• AddressKey(required): integer(int64)
  The unique identifier of the project address.

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: string
  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: string
  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 : publicSectorProjectAddresses-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

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

  Maximum Length: 240

  The fourth address line, if applicable.
• AddressField1: string
  Title: Address Field 1

  Maximum Length: 20

  The additional first address or main address information of the parcel address.
• AddressField2: string
  Title: Address Field 2

  Maximum Length: 20

  The additional second address information of the parcel address if available.
• AddressField3: string
  Title: Address Field 3

  Maximum Length: 20

  The additional third address information of the parcel address, if available.
• AddressId: integer (int64)
  Title: Address ID

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

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

  Maximum Length: 20

  The type of address that is used for the delivery point validation (DPV). For example, main address, side address, or virtual address.
• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the public sector agency.
• BuildingType: string
  Title: Building Type

  Maximum Length: 20

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

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 60

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

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

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

  Maximum Length: 60

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

  Maximum Length: 60

  The name of the county in the parcel address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the project parcel address.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the project parcel address was created.
• EmailId: string
  Title: Email Address

  Maximum Length: 50

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

  Maximum Length: 10

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

  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 Code

  Maximum Length: 10

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

  Maximum Length: 40

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

  Maximum Length: 1

  Indicates how the data was entered or loaded into the application. The value 'S' indicates that the data entered is the system data and the value 'U' indicates the user-entered data.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The name of the user who last updated the project parcel address.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date when the project parcel address was last updated.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login ID of the user who last updated the project parcel address.
• Latitude: number
  Title: Latitude

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

  The link relations associated with the resource instance.
• Longitude: number
  Title: Longitude

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

  Maximum Length: 20

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

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

  The unique identifier of the project parcel.
• 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

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

  Maximum Length: 1

  Default Value: false

  Indicates if the current project address is the primary parcel address. The value 'Y' indicates that the parcel address is the primary parcel address and the value 'N' indicates that parcel address is not the primary parcel address. The default value is 'N'.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• Province: string
  Title: Province

  Maximum Length: 60

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

  The identifier of the parcel address. The Spatial Reference System Identifier (SRID) identifies the projected, not projected, and the local spatial coordinate system definitions. The identifier is used in all GIS systems.
• State: string
  Title: State

  Maximum Length: 60

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

  Maximum Length: 10

  The street direction in the address search. Valid values are the compass directions such as N, S, E, W, NW, SE, and others. For example, the search can result in a list all parcels with a street direction that is to the north of the city center.
• StreetName: string
  Title: Street Name

  Maximum Length: 240

  The name of the street in the parcel address used at the time of search.
• StreetNumber: string
  Title: Street Number

  Maximum Length: 20

  The street number in the parcel address.
• StreetType: string
  Title: Street Type

  Maximum Length: 20

  The type of street that is used at the time of search. For example, alley, boulevard, avenue, lane, street, loop, and so on.
• UnitNumber: string
  Title: Unit Number

  Maximum Length: 30

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

  Maximum Length: 10

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

  Maximum Length: 40

  The work telephone number of the parcel address contact.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the street in the parcel address used at the time of search.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the project parcel address was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the cell phone number of parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "InputSource":{
            "title":"Input Source",
            "maxLength":1,
            "type":"string",
            "description":"Indicates how the data was entered or loaded into the application. The value 'S' indicates that the data entered is the system data and the value 'U' indicates the user-entered data.",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the fax number of the parcel contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "title":"Latitude",
            "type":"number",
            "description":"The latitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. For example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building Type",
            "maxLength":20,
            "type":"string",
            "description":"The type of building used in the address search. For example, Tower A or Block 3.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code for the work telephone number of the parcel 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 ID",
            "type":"integer",
            "description":"The unique identifier of the project parcel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AddressId":{
            "title":"Address ID",
            "type":"integer",
            "description":"The identifier of the parcel address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the project parcel address was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email Address",
            "maxLength":50,
            "type":"string",
            "description":"The email address of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the project parcel address.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HomePhoneNum":{
            "title":"Home Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The home telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressKey":{
            "title":"Address ID",
            "type":"integer",
            "description":"The unique identifier of the project address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The name of the city in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":20,
            "type":"string",
            "description":"The type of street that is used at the time of search. For example, alley, boulevard, avenue, lane, street, loop, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "title":"Longitude",
            "type":"number",
            "description":"The longitude value of the parcel address. A geographic location typically identifies a specific entrance area within a large parcel address. 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 name of the province in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":20,
            "type":"string",
            "description":"The extended postal code in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The name of the state in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "description":"The name of the country in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Street Direction",
            "maxLength":10,
            "type":"string",
            "description":"The street direction in the address search. Valid values are the compass directions such as N, S, E, W, NW, SE, and others. For example, the search can result in a list all parcels with a street direction that is to the north of the city center.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit Number",
            "maxLength":30,
            "type":"string",
            "description":"The particular unit in a building used in an address search. For example, Apartment 208A or Suite 300.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "title":"X Coordinate",
            "type":"number",
            "description":"The x-axis coordinate value of the project parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "title":"Y Coordinate",
            "type":"number",
            "description":"The y-axis coordinate value of the project parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the project parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the current project address is the primary parcel address. The value 'Y' indicates that the parcel address is the primary parcel address and the value 'N' indicates that parcel address is not the primary parcel address. The default value is 'N'.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FaxNum":{
            "title":"Fax Number",
            "maxLength":40,
            "type":"string",
            "description":"The fax 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 name of the county in the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "description":"The fourth address line, if applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "AddressField1":{
            "title":"Address Field 1",
            "maxLength":20,
            "type":"string",
            "description":"The additional first address or main address information of the parcel address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField3":{
            "title":"Address Field 3",
            "maxLength":20,
            "type":"string",
            "description":"The additional third address information of the parcel address, if available.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressField2":{
            "title":"Address Field 2",
            "maxLength":20,
            "type":"string",
            "description":"The additional second address information of the parcel address if available.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel ID",
            "type":"integer",
            "description":"The identifier of the parcel.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line, if applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "description":"The third address line, if applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first or the main address.",
            "nullable":true,
            "x-queryable":true
        },
        "MunicipalityId":{
            "title":"Municipality ID",
            "maxLength":20,
            "type":"string",
            "description":"The municipality identifier if the parcel is not managed at the county level.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneNum":{
            "title":"Work Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The work telephone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneNum":{
            "title":"Cell Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel address contact.",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country Code",
            "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 type of address that is used for the 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 identifier of the parcel address. The Spatial Reference System Identifier (SRID) identifies the projected, not projected, and the local spatial coordinate system definitions. The identifier is 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 name of the user who last updated the project parcel address.",
            "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