Jump to

• Request
• Response

Create a set of record parcel owners

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordQueries/{LnpRecordKey}/child/RecordParcel/{ParcelKey}/child/ParcelOwner

Request

Path Parameters

• LnpRecordKey(required): integer
  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.
• ParcelKey(required): integer(int64)
  The unique identifier for the parcel associated with a parcel address.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240
• Address2: string
  Title: Address Line 2

  Maximum Length: 240
• Address3: string
  Title: Address Line 3

  Maximum Length: 240
• Address4: string
  Title: Address Line 4

  Maximum Length: 240
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• BuildingType: string
  Title: Building

  Maximum Length: 20
• CellPhoneCountry: string
  Title: Cell Phone Country

  Maximum Length: 10
• CellPhoneNumber: string
  Title: Cell Phone

  Maximum Length: 40
• City: string
  Title: City

  Maximum Length: 60
• Country: string
  Title: Country

  Maximum Length: 60
• County: string
  Title: County

  Maximum Length: 60
• DocumentNumber: string
  Title: Document

  Maximum Length: 50
• EmailId: string
  Title: Email

  Maximum Length: 50
• FaxCountry: string
  Title: Fax Country

  Maximum Length: 10
• FaxNumber: string
  Title: Fax

  Maximum Length: 40
• Floor: string
  Title: Floor

  Maximum Length: 20
• HomePhoneCountry: string
  Title: Home Phone Country

  Maximum Length: 10
• HomePhoneNumber: string
  Title: Home Phone

  Maximum Length: 40
• LastTransferDate: string (date)
  Title: Last Transfer Date
• LastTransferType: string
  Title: Last Transfer Type

  Maximum Length: 50
• LnpRecordId: string
  Title: Record ID

  Maximum Length: 50
• LnpRecordKey: integer (int64)
  Title: Record
• Owner: string
  Title: Owner

  Maximum Length: 150
• OwnerId: integer (int64)
  Title: Owner
• OwnerKey: integer (int64)
  Title: Owner Key
• OwnerType: string
  Title: Ownership Type

  Maximum Length: 20
• ParcelId: integer (int64)
  Title: Parcel
• ParcelKey: integer (int64)
  Title: Parcel Key
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1
• Province: string
  Title: Province

  Maximum Length: 60
• SecondaryOwner: string
  Title: Secondary Owner

  Maximum Length: 150
• State: string
  Title: State

  Maximum Length: 60
• StreetDirection: string
  Title: Direction

  Maximum Length: 10
• StreetName: string
  Title: Street

  Maximum Length: 240
• StreetNumber: string
  Title: Street Number

  Maximum Length: 20
• StreetType: string
  Title: Street Type

  Maximum Length: 20
• UnitNumber: string
  Title: Unit

  Maximum Length: 30
• WorkPhoneCountry: string
  Title: Work Phone Country

  Maximum Length: 10
• WorkPhoneNumber: string
  Title: Work Phone

  Maximum Length: 40

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "CellPhoneNumber":{
            "title":"Cell Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "WorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true
        },
        "FaxCountry":{
            "title":"Fax Country",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "OwnerType":{
            "title":"Ownership Type",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "BuildingType":{
            "title":"Building",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "OwnerId":{
            "title":"Owner",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":40,
            "type":"string",
            "nullable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "ParcelKey":{
            "title":"Parcel Key",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SecondaryOwner":{
            "title":"Secondary Owner",
            "maxLength":150,
            "type":"string",
            "nullable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Floor":{
            "title":"Floor",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "DocumentNumber":{
            "title":"Document",
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "OwnerKey":{
            "title":"Owner Key",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "StreetDirection":{
            "title":"Direction",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "nullable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country",
            "maxLength":10,
            "type":"string",
            "nullable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "format":"date",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorRecordQueries-RecordParcel-ParcelOwner-item-response

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Maximum Length: 240
• Address2: string
  Title: Address Line 2

  Maximum Length: 240
• Address3: string
  Title: Address Line 3

  Maximum Length: 240
• Address4: string
  Title: Address Line 4

  Maximum Length: 240
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1
• BuildingType: string
  Title: Building

  Maximum Length: 20
• CellPhoneCountry: string
  Title: Cell Phone Country

  Maximum Length: 10
• CellPhoneNumber: string
  Title: Cell Phone

  Maximum Length: 40
• City: string
  Title: City

  Maximum Length: 60
• Country: string
  Title: Country

  Maximum Length: 60
• County: string
  Title: County

  Maximum Length: 60
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• DocumentNumber: string
  Title: Document

  Maximum Length: 50
• EmailId: string
  Title: Email

  Maximum Length: 50
• FaxCountry: string
  Title: Fax Country

  Maximum Length: 10
• FaxNumber: string
  Title: Fax

  Maximum Length: 40
• Floor: string
  Title: Floor

  Maximum Length: 20
• HomePhoneCountry: string
  Title: Home Phone Country

  Maximum Length: 10
• HomePhoneNumber: string
  Title: Home Phone

  Maximum Length: 40
• LastTransferDate: string (date)
  Title: Last Transfer Date
• LastTransferType: string
  Title: Last Transfer Type

  Maximum Length: 50
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true
• links: array Links
  Title: Links

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

  Maximum Length: 50
• LnpRecordKey: integer (int64)
  Title: Record
• Owner: string
  Title: Owner

  Maximum Length: 150
• OwnerId: integer (int64)
  Title: Owner
• OwnerKey: integer (int64)
  Title: Owner Key
• OwnerType: string
  Title: Ownership Type

  Maximum Length: 20
• ParcelId: integer (int64)
  Title: Parcel
• ParcelKey: integer (int64)
  Title: Parcel Key
• PostalCode: string
  Title: Postal Code

  Maximum Length: 60
• PostalPlus4Code: string
  Title: Postal Plus 4 Code

  Maximum Length: 20
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1
• Province: string
  Title: Province

  Maximum Length: 60
• SecondaryOwner: string
  Title: Secondary Owner

  Maximum Length: 150
• State: string
  Title: State

  Maximum Length: 60
• StreetDirection: string
  Title: Direction

  Maximum Length: 10
• StreetName: string
  Title: Street

  Maximum Length: 240
• StreetNumber: string
  Title: Street Number

  Maximum Length: 20
• StreetType: string
  Title: Street Type

  Maximum Length: 20
• UnitNumber: string
  Title: Unit

  Maximum Length: 30
• WorkPhoneCountry: string
  Title: Work Phone Country

  Maximum Length: 10
• WorkPhoneNumber: string
  Title: Work Phone

  Maximum Length: 40

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CellPhoneNumber":{
            "title":"Cell Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Owner":{
            "title":"Owner",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CellPhoneCountry":{
            "title":"Cell Phone Country",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "WorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FaxCountry":{
            "title":"Fax Country",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerType":{
            "title":"Ownership Type",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "BuildingType":{
            "title":"Building",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneNumber":{
            "title":"Home Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "WorkPhoneCountry":{
            "title":"Work Phone Country",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FaxNumber":{
            "title":"Fax",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "title":"Street Number",
            "maxLength":20,
            "type":"string",
            "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",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Secondary Owner",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Floor":{
            "title":"Floor",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "EmailId":{
            "title":"Email",
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferType":{
            "title":"Last Transfer Type",
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Document",
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "title":"Owner Key",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StreetDirection":{
            "title":"Direction",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "title":"Unit",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "HomePhoneCountry":{
            "title":"Home Phone Country",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LastTransferDate":{
            "title":"Last Transfer Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "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