Create a parcel owner
post
/fscmRestApi/resources/11.13.18.05/publicSectorParcelOwners
Request
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
Root Schema : schema
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first line of the parcel owner address. -
Address2: string
Maximum Length:
240
The second line of the parcel owner address. -
BuildingType: string
Maximum Length:
20
The building type of the parcel owner. -
CellPhoneCountry: string
Maximum Length:
10
Tthe cell phone country code of the parcel owner. -
CellPhoneNumber: string
Maximum Length:
40
The cell phone number of the parcel owner. -
City: string
Maximum Length:
60
The city of the parcel owner. -
Country: string
Maximum Length:
3
The country of the parcel owner. -
County: string
Maximum Length:
60
The county of the parcel owner. -
DocumentNumber: string
Title:
Document Number
Maximum Length:50
The document number of the parcel owner. -
EmailId: string
Maximum Length:
50
The email address for the parcel owner. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the parcel owner is available to be used. The default value is N. -
FaxCountry: string
Maximum Length:
10
The fax country code of the parcel owner. -
FaxNumber: string
Maximum Length:
40
The fax phone number of the parcel owner. -
Floor: string
Maximum Length:
20
The floor the parcel owner is on. -
HomePhoneCountry: string
Maximum Length:
10
The home phone country code of the parcel owner. -
HomePhoneNumber: string
Maximum Length:
40
The home phone number of the parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the parcel owner. -
OwnerCode: string
Maximum Length:
480
The code of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier for the parcel owner. -
OwnerName: string
Title:
Owner
Maximum Length:150
The name of the primary parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
PostalCode: string
Maximum Length:
60
The postal code of the parcel owner. -
PrimaryFlag: boolean
Maximum Length:
1
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. -
SecondaryOwnerName: string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary parcel owner. -
State: string
Maximum Length:
60
The state of the parcel owner. -
StreeName: string
Maximum Length:
240
The street name of the parcel owner. -
StreetDirection: string
Maximum Length:
10
The street direction of the parcel owner. -
StreetNumber: string
Maximum Length:
20
The street number of the parcel owner. -
StreetType: string
Maximum Length:
20
The street type of the parcel owner. -
UnitNumber: string
Maximum Length:
30
The unit number of the parcel owner. -
WorkPhoneCountry: string
Maximum Length:
10
The work phone country code of the parcel owner. -
WorkPhoneNumber: string
Maximum Length:
40
The work phone number of the parcel owner.
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.
Root Schema : publicSectorParcelOwners-item-response
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first line of the parcel owner address. -
Address2: string
Maximum Length:
240
The second line of the parcel owner address. -
Address3: string
Read Only:
true
Maximum Length:240
The third line of the parcel owner address. -
Address4: string
Read Only:
true
Maximum Length:240
The fourth line of the parcel owner address. -
BuildingType: string
Maximum Length:
20
The building type of the parcel owner. -
CellPhoneCountry: string
Maximum Length:
10
Tthe cell phone country code of the parcel owner. -
CellPhoneNumber: string
Maximum Length:
40
The cell phone number of the parcel owner. -
City: string
Maximum Length:
60
The city of the parcel owner. -
Country: string
Maximum Length:
3
The country of the parcel owner. -
County: string
Maximum Length:
60
The county of the parcel owner. -
DocumentNumber: string
Title:
Document Number
Maximum Length:50
The document number of the parcel owner. -
EmailId: string
Maximum Length:
50
The email address for the parcel owner. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the parcel owner is available to be used. The default value is N. -
FaxCountry: string
Maximum Length:
10
The fax country code of the parcel owner. -
FaxNumber: string
Maximum Length:
40
The fax phone number of the parcel owner. -
Floor: string
Maximum Length:
20
The floor the parcel owner is on. -
HomePhoneCountry: string
Maximum Length:
10
The home phone country code of the parcel owner. -
HomePhoneNumber: string
Maximum Length:
40
The home phone number of the parcel owner. -
LastTransferType: string
Title:
Last Transfer Type
Maximum Length:50
The last transfer type of the parcel owner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerCode: string
Maximum Length:
480
The code of the parcel owner. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier for the parcel owner. -
OwnerName: string
Title:
Owner
Maximum Length:150
The name of the primary parcel owner. -
OwnerType: string
Title:
Owner Type
Maximum Length:20
The type of parcel owner. -
ParcelId: integer
(int64)
The unique identifier for the parcel.
-
ParcelIdEntered: string
Title:
Parcel Number
Maximum Length:30
The parcel number. -
PostalCode: string
Maximum Length:
60
The postal code of the parcel owner. -
PostalPlus4Code: string
Read Only:
true
Maximum Length:10
The postal plus 4 code of the parcel owner. -
PrimaryFlag: boolean
Maximum Length:
1
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: string
Read Only:
true
Maximum Length:60
The province of the parcel owner. -
SecondaryOwnerName: string
Title:
Secondary Owner
Maximum Length:150
The name of the secondary parcel owner. -
State: string
Maximum Length:
60
The state of the parcel owner. -
StreeName: string
Maximum Length:
240
The street name of the parcel owner. -
StreetDirection: string
Maximum Length:
10
The street direction of the parcel owner. -
StreetNumber: string
Maximum Length:
20
The street number of the parcel owner. -
StreetType: string
Maximum Length:
20
The street type of the parcel owner. -
UnitNumber: string
Maximum Length:
30
The unit number of the parcel owner. -
WorkPhoneCountry: string
Maximum Length:
10
The work phone country code of the parcel owner. -
WorkPhoneNumber: string
Maximum Length:
40
The work phone number of the parcel owner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.