Jump to

• Request
• Response

Create a parcel owner

post

/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners

Request

Supported Media Types

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

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

  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.
• ParcelIdEntered(optional): string
  Title: Parcel Number

  Maximum Length: 30

  The parcel number.
• 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.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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

  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.
• ParcelIdEntered(optional): string
  Title: Parcel Number

  Maximum Length: 30

  The parcel number.
• 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.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top