Jump to

• Request
• Response

Copies the record parcel address information of the application.

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecParcels/{ParcelKey}/child/ParcelAddress

Copies the parcel address information from the common parcel setup for the application.

Request

Supported Media Types

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

Path Parameters

• ParcelKey: integer
  The unique identifier for a parcel.

Body ()

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

Root Schema : publicSectorRecParcels-ParcelAddress-copyParcelAddressInfoRequest

Type: object

Show Source

• name(optional): string
  Allowed Values: [ "copyParcelAddressInfo" ]

  This parameter value must be set to "copyParcelAddressInfo".
• parameters(optional): array parameters
  Minimum Number of Items: 4

  Maximum Number of Items: 4

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "copyParcelAddressInfo"
            ],
            "description":"This parameter value must be set to \"copyParcelAddressInfo\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "addressKeys":{
                            "type":"string",
                            "description":"Retrieves the unique identifier of the copied address keys."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "parcelKey":{
                            "type":"string",
                            "description":"Retrieves the unique identifier of the copied parcels."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "recordKey":{
                            "type":"string",
                            "description":"Retrieves the unique identifier of the application."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "recordId":{
                            "type":"string",
                            "description":"Retrieves the logical identifier for the application."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                }
            ],
            "minItems":4,
            "maxItems":4,
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : parameters

Type: array

Minimum Number of Items: 4

Maximum Number of Items: 4

Show Source

• [0]: object parameters-items[0]
• [1]: object parameters-items[1]
• [2]: object parameters-items[2]
• [3]: object parameters-items[3]

{
    "items":[
        {
            "properties":{
                "addressKeys":{
                    "type":"string",
                    "description":"Retrieves the unique identifier of the copied address keys."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "parcelKey":{
                    "type":"string",
                    "description":"Retrieves the unique identifier of the copied parcels."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "recordKey":{
                    "type":"string",
                    "description":"Retrieves the unique identifier of the application."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"Retrieves the logical identifier for the application."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":4,
    "maxItems":4,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• addressKeys(optional): string
  Retrieves the unique identifier of the copied address keys.

{
    "properties":{
        "addressKeys":{
            "type":"string",
            "description":"Retrieves the unique identifier of the copied address keys."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[1]

Type: object

Show Source

• parcelKey(optional): string
  Retrieves the unique identifier of the copied parcels.

{
    "properties":{
        "parcelKey":{
            "type":"string",
            "description":"Retrieves the unique identifier of the copied parcels."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[2]

Type: object

Show Source

• recordKey(optional): string
  Retrieves the unique identifier of the application.

{
    "properties":{
        "recordKey":{
            "type":"string",
            "description":"Retrieves the unique identifier of the application."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[3]

Type: object

Show Source

• recordId(optional): string
  Retrieves the logical identifier for the application.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"Retrieves the logical identifier for the application."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRecParcels-ParcelAddress-copyParcelAddressInfoResponse

Type: object

Show Source

• return(optional): string
  Retrieves the result of the copy action. It could be the unique identifier for the first copied parcel address or exception information.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"Retrieves the result of the copy action. It could be the unique identifier for the first copied parcel address or exception information."
        }
    },
    "type":"object"
}

Back to Top