Jump to

• Request
• Response

Create a parcel genealogy transaction detail

post

/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}/child/ParcelTransactionDetail

Request

Path Parameters

• ParcelTrxKey(required): integer(int64)
  The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.

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 ()

Root Schema : schema

Type: object

Show Source

• ExistingParcel: string
  Maximum Length: 1

  Indicates whether parcel was previously created in the system or it is being created with the parcel genealogy transaction.
• FinalParcelIdEntered: string
  Maximum Length: 30

  The final parcel number (APN) typically assigned by the county.
• MigratedDataFlag: string
  Maximum Length: 3

  Indicates whether the transaction was created online or migrated from a legacy system.
• ParcelId: integer
  The unique identifier of the parcel of real estate in the genealogy transaction. Mandatory system-generated value.
• ParcelIdEntered: string
  Maximum Length: 30

  The unique identifier of the child parcel in the genealogy transaction. Mandatory user supplied value.
• ParcelTrxDtlKey: string
  Maximum Length: 18

  The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.
• ParcelTrxDtlPuid: string
  Maximum Length: 480

  The public unique identifier of the parcel genealogy transaction detail.
• ParcelTrxKey: integer (int64)
  The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
• ParcelTrxPuid: string
  Maximum Length: 480

  The public unique identifier of the parcel genealogy transaction.
• PreviousState: string
  Maximum Length: 20

  The previous state of this row.
• ProvisionalParcelIdEntered: string
  Maximum Length: 30

  The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available.
• Relationship: string
  Maximum Length: 15

  The relationship of the parcels included in a genealogy transaction.
• Temporary: string
  Maximum Length: 1

  Indicates whether the data in this row is temporary.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the transaction was created online or migrated from a legacy system.",
            "nullable":true
        },
        "ParcelTrxDtlPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the parcel genealogy transaction detail.",
            "nullable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier of the parcel of real estate in the genealogy transaction. Mandatory system-generated value.",
            "nullable":true
        },
        "ParcelTrxPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the parcel genealogy transaction.",
            "nullable":true
        },
        "ExistingParcel":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether parcel was previously created in the system or it is being created with the parcel genealogy transaction.",
            "nullable":true
        },
        "ParcelTrxKey":{
            "type":"integer",
            "description":"The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PreviousState":{
            "maxLength":20,
            "type":"string",
            "description":"The previous state of this row.",
            "nullable":true
        },
        "Temporary":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the data in this row is temporary.",
            "nullable":true
        },
        "ParcelTrxDtlKey":{
            "maxLength":18,
            "type":"string",
            "description":"The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Relationship":{
            "maxLength":15,
            "type":"string",
            "description":"The relationship of the parcels included in a genealogy transaction.",
            "nullable":false
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the child parcel in the genealogy transaction. Mandatory user supplied value.",
            "nullable":true
        },
        "ProvisionalParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available.",
            "nullable":true
        },
        "FinalParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The final parcel number (APN) typically assigned by the county.",
            "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 : publicSectorParcelTransactionHeaders-ParcelTransactionDetail-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Read Only: true

  The date and time when the parcel genealogy transaction detail was created.
• ExistingParcel: string
  Maximum Length: 1

  Indicates whether parcel was previously created in the system or it is being created with the parcel genealogy transaction.
• FinalParcelIdEntered: string
  Maximum Length: 30

  The final parcel number (APN) typically assigned by the county.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the parcel genealogy transaction detail was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MigratedDataFlag: string
  Maximum Length: 3

  Indicates whether the transaction was created online or migrated from a legacy system.
• ParcelId: integer
  The unique identifier of the parcel of real estate in the genealogy transaction. Mandatory system-generated value.
• ParcelIdEntered: string
  Maximum Length: 30

  The unique identifier of the child parcel in the genealogy transaction. Mandatory user supplied value.
• ParcelTrxDtlKey: string
  Maximum Length: 18

  The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.
• ParcelTrxDtlPuid: string
  Maximum Length: 480

  The public unique identifier of the parcel genealogy transaction detail.
• ParcelTrxKey: integer (int64)
  The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
• ParcelTrxPuid: string
  Maximum Length: 480

  The public unique identifier of the parcel genealogy transaction.
• PreviousState: string
  Maximum Length: 20

  The previous state of this row.
• ProvisionalParcelIdEntered: string
  Maximum Length: 30

  The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available.
• Relationship: string
  Maximum Length: 15

  The relationship of the parcels included in a genealogy transaction.
• RelationshipMeaning: string
  Read Only: true

  Maximum Length: 80

  The description of the relationship of the parcel within the transaction.
• Temporary: string
  Maximum Length: 1

  Indicates whether the data in this row is temporary.

{
    "type":"object",
    "properties":{
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the transaction was created online or migrated from a legacy system.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelTrxDtlPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the parcel genealogy transaction detail.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the relationship of the parcel within the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the parcel genealogy transaction detail was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelId":{
            "type":"integer",
            "description":"The unique identifier of the parcel of real estate in the genealogy transaction. Mandatory system-generated value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelTrxPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the parcel genealogy transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ExistingParcel":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether parcel was previously created in the system or it is being created with the parcel genealogy transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelTrxKey":{
            "type":"integer",
            "description":"The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviousState":{
            "maxLength":20,
            "type":"string",
            "description":"The previous state of this row.",
            "nullable":true,
            "x-queryable":true
        },
        "Temporary":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the data in this row is temporary.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelTrxDtlKey":{
            "maxLength":18,
            "type":"string",
            "description":"The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Relationship":{
            "maxLength":15,
            "type":"string",
            "description":"The relationship of the parcels included in a genealogy transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the child parcel in the genealogy transaction. Mandatory user supplied value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProvisionalParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The final parcel number (APN) typically assigned by the county.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the parcel genealogy transaction detail was last updated.",
            "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