Jump to

• Request
• Response

Update a parcel owner

patch

/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners/{publicSectorParcelOwnersUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

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

Body ()

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

Root Schema : publicSectorParcelOwners-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first line of the parcel owner address.
• Address2(optional): string
  Maximum Length: 240

  The second line of the parcel owner address.
• Address3(optional): string
  Maximum Length: 240

  The third line of the parcel owner address.
• Address4(optional): string
  Maximum Length: 240

  The fourth line of the parcel owner address.
• BuildingType(optional): string
  Maximum Length: 20

  The building type of the parcel owner.
• CellPhoneCountry(optional): string
  Maximum Length: 10

  Tthe cell phone country code of the parcel owner.
• CellPhoneNumber(optional): string
  Maximum Length: 40

  The cell phone number of the parcel owner.
• City(optional): string
  Maximum Length: 60

  The city of the parcel owner.
• Country(optional): string
  Maximum Length: 3

  The country of the parcel owner.
• County(optional): string
  Maximum Length: 60

  The county of the parcel owner.
• DocumentNumber(optional): string
  Title: Document Number

  Maximum Length: 50

  The document number of the parcel owner.
• EmailId(optional): string
  Maximum Length: 50

  The email address for the parcel owner.
• EnabledFlag(optional): boolean
  Indicates whether the parcel owner is available to be used. The default value is N.
• FaxCountry(optional): string
  Maximum Length: 10

  The fax country code of the parcel owner.
• FaxNumber(optional): string
  Maximum Length: 40

  The fax phone number of the parcel owner.
• Floor(optional): string
  Maximum Length: 20

  The floor the parcel owner is on.
• HomePhoneCountry(optional): string
  Maximum Length: 10

  The home phone country code of the parcel owner.
• HomePhoneNumber(optional): string
  Maximum Length: 40

  The home phone number of the parcel owner.
• LastTransferType(optional): string
  Title: Last Transfer Type

  Maximum Length: 50

  The last transfer type of the parcel owner.
• links(optional): array Items
  Title: Items

  Link Relations
• OwnerCode(optional): string
  Maximum Length: 32

  The code of the parcel owner.
• OwnerId(optional): integer(int64)
  Title: Owner ID

  The unique identifier for the parcel owner.
• OwnerName(optional): string
  Title: Owner

  Maximum Length: 150

  The name of the primary parcel owner.
• OwnerType(optional): string
  Title: Owner Type

  Maximum Length: 20

  The type of parcel owner.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code of the parcel owner.
• PostalPlus4Code(optional): string
  Maximum Length: 10

  The postal plus 4 code of the parcel owner.
• PrimaryFlag(optional): boolean
  Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N.
• Province(optional): string
  Maximum Length: 60

  The province of the parcel owner.
• SecondaryOwnerName(optional): string
  Title: Secondary Owner

  Maximum Length: 150

  The name of the secondary parcel owner.
• State(optional): string
  Maximum Length: 60

  The state of the parcel owner.
• StreeName(optional): string
  Maximum Length: 240

  The street name of the parcel owner.
• StreetDirection(optional): string
  Maximum Length: 10

  The street direction of the parcel owner.
• StreetNumber(optional): string
  Maximum Length: 20

  The street number of the parcel owner.
• StreetType(optional): string
  Maximum Length: 20

  The street type of the parcel owner.
• UnitNumber(optional): string
  Maximum Length: 30

  The unit number of the parcel owner.
• WorkPhoneCountry(optional): string
  Maximum Length: 10

  The work phone country code of the parcel owner.
• WorkPhoneNumber(optional): string
  Maximum Length: 40

  The work phone number of the parcel owner.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel owner address."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel owner address."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the parcel owner address."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the parcel owner address."
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"The building type of the parcel owner."
        },
        "CellPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"Tthe cell phone country code of the parcel owner."
        },
        "CellPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel owner."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the parcel owner."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the parcel owner."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the parcel owner."
        },
        "DocumentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The document number of the parcel owner.",
            "title":"Document Number"
        },
        "EmailId":{
            "maxLength":50,
            "type":"string",
            "description":"The email address for the parcel owner."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel owner is available to be used. The default value is N."
        },
        "FaxCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The fax country code of the parcel owner."
        },
        "FaxNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The fax phone number of the parcel owner."
        },
        "Floor":{
            "maxLength":20,
            "type":"string",
            "description":"The floor the parcel owner is on."
        },
        "HomePhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The home phone country code of the parcel owner."
        },
        "HomePhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the parcel owner."
        },
        "LastTransferType":{
            "maxLength":50,
            "type":"string",
            "description":"The last transfer type of the parcel owner.",
            "title":"Last Transfer Type"
        },
        "OwnerCode":{
            "maxLength":32,
            "type":"string",
            "description":"The code of the parcel owner."
        },
        "OwnerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel owner.",
            "title":"Owner ID"
        },
        "OwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the primary parcel owner.",
            "title":"Owner"
        },
        "OwnerType":{
            "maxLength":20,
            "type":"string",
            "description":"The type of parcel owner.",
            "title":"Owner Type"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the parcel owner."
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus 4 code of the parcel owner."
        },
        "PrimaryFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the parcel owner."
        },
        "SecondaryOwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the secondary parcel owner.",
            "title":"Secondary Owner"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the parcel owner."
        },
        "StreeName":{
            "maxLength":240,
            "type":"string",
            "description":"The street name of the parcel owner."
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the parcel owner."
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the parcel owner."
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type of the parcel owner."
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel owner."
        },
        "WorkPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The work phone country code of the parcel owner."
        },
        "WorkPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the parcel owner."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorParcelOwners-item

Type: object

Show Source

• Address1(optional): string
  Maximum Length: 240

  The first line of the parcel owner address.
• Address2(optional): string
  Maximum Length: 240

  The second line of the parcel owner address.
• Address3(optional): string
  Maximum Length: 240

  The third line of the parcel owner address.
• Address4(optional): string
  Maximum Length: 240

  The fourth line of the parcel owner address.
• BuildingType(optional): string
  Maximum Length: 20

  The building type of the parcel owner.
• CellPhoneCountry(optional): string
  Maximum Length: 10

  Tthe cell phone country code of the parcel owner.
• CellPhoneNumber(optional): string
  Maximum Length: 40

  The cell phone number of the parcel owner.
• City(optional): string
  Maximum Length: 60

  The city of the parcel owner.
• Country(optional): string
  Maximum Length: 3

  The country of the parcel owner.
• County(optional): string
  Maximum Length: 60

  The county of the parcel owner.
• DocumentNumber(optional): string
  Title: Document Number

  Maximum Length: 50

  The document number of the parcel owner.
• EmailId(optional): string
  Maximum Length: 50

  The email address for the parcel owner.
• EnabledFlag(optional): boolean
  Indicates whether the parcel owner is available to be used. The default value is N.
• FaxCountry(optional): string
  Maximum Length: 10

  The fax country code of the parcel owner.
• FaxNumber(optional): string
  Maximum Length: 40

  The fax phone number of the parcel owner.
• Floor(optional): string
  Maximum Length: 20

  The floor the parcel owner is on.
• HomePhoneCountry(optional): string
  Maximum Length: 10

  The home phone country code of the parcel owner.
• HomePhoneNumber(optional): string
  Maximum Length: 40

  The home phone number of the parcel owner.
• LastTransferType(optional): string
  Title: Last Transfer Type

  Maximum Length: 50

  The last transfer type of the parcel owner.
• links(optional): array Items
  Title: Items

  Link Relations
• OwnerCode(optional): string
  Maximum Length: 32

  The code of the parcel owner.
• OwnerId(optional): integer(int64)
  Title: Owner ID

  The unique identifier for the parcel owner.
• OwnerName(optional): string
  Title: Owner

  Maximum Length: 150

  The name of the primary parcel owner.
• OwnerType(optional): string
  Title: Owner Type

  Maximum Length: 20

  The type of parcel owner.
• ParcelId(optional): integer(int64)
  The unique identifier for the parcel.
• PostalCode(optional): string
  Maximum Length: 60

  The postal code of the parcel owner.
• PostalPlus4Code(optional): string
  Maximum Length: 10

  The postal plus 4 code of the parcel owner.
• PrimaryFlag(optional): boolean
  Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N.
• Province(optional): string
  Maximum Length: 60

  The province of the parcel owner.
• SecondaryOwnerName(optional): string
  Title: Secondary Owner

  Maximum Length: 150

  The name of the secondary parcel owner.
• State(optional): string
  Maximum Length: 60

  The state of the parcel owner.
• StreeName(optional): string
  Maximum Length: 240

  The street name of the parcel owner.
• StreetDirection(optional): string
  Maximum Length: 10

  The street direction of the parcel owner.
• StreetNumber(optional): string
  Maximum Length: 20

  The street number of the parcel owner.
• StreetType(optional): string
  Maximum Length: 20

  The street type of the parcel owner.
• UnitNumber(optional): string
  Maximum Length: 30

  The unit number of the parcel owner.
• WorkPhoneCountry(optional): string
  Maximum Length: 10

  The work phone country code of the parcel owner.
• WorkPhoneNumber(optional): string
  Maximum Length: 40

  The work phone number of the parcel owner.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel owner address."
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel owner address."
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the parcel owner address."
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the parcel owner address."
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"The building type of the parcel owner."
        },
        "CellPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"Tthe cell phone country code of the parcel owner."
        },
        "CellPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The cell phone number of the parcel owner."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the parcel owner."
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the parcel owner."
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the parcel owner."
        },
        "DocumentNumber":{
            "maxLength":50,
            "type":"string",
            "description":"The document number of the parcel owner.",
            "title":"Document Number"
        },
        "EmailId":{
            "maxLength":50,
            "type":"string",
            "description":"The email address for the parcel owner."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel owner is available to be used. The default value is N."
        },
        "FaxCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The fax country code of the parcel owner."
        },
        "FaxNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The fax phone number of the parcel owner."
        },
        "Floor":{
            "maxLength":20,
            "type":"string",
            "description":"The floor the parcel owner is on."
        },
        "HomePhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The home phone country code of the parcel owner."
        },
        "HomePhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The home phone number of the parcel owner."
        },
        "LastTransferType":{
            "maxLength":50,
            "type":"string",
            "description":"The last transfer type of the parcel owner.",
            "title":"Last Transfer Type"
        },
        "OwnerCode":{
            "maxLength":32,
            "type":"string",
            "description":"The code of the parcel owner."
        },
        "OwnerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel owner.",
            "title":"Owner ID"
        },
        "OwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the primary parcel owner.",
            "title":"Owner"
        },
        "OwnerType":{
            "maxLength":20,
            "type":"string",
            "description":"The type of parcel owner.",
            "title":"Owner Type"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the parcel."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the parcel owner."
        },
        "PostalPlus4Code":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus 4 code of the parcel owner."
        },
        "PrimaryFlag":{
            "type":"boolean",
            "description":"Indicates whether the parcel owner is the primary owner for the parcel. If the value is Y, the parcel owner is the primary owner. The default value is N."
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the parcel owner."
        },
        "SecondaryOwnerName":{
            "maxLength":150,
            "type":"string",
            "description":"The name of the secondary parcel owner.",
            "title":"Secondary Owner"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the parcel owner."
        },
        "StreeName":{
            "maxLength":240,
            "type":"string",
            "description":"The street name of the parcel owner."
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the parcel owner."
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the parcel owner."
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type of the parcel owner."
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the parcel owner."
        },
        "WorkPhoneCountry":{
            "maxLength":10,
            "type":"string",
            "description":"The work phone country code of the parcel owner."
        },
        "WorkPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The work phone number of the parcel owner."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top