REST API for Oracle Public Sector Permitting and Licensing

Get a time recording transaction

get

/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingTransactions/{publicSectorTimeRecordingTransactionsUniqID}

Request

Path Parameters

publicSectorTimeRecordingTransactionsUniqID(required): string

This is the hash key of the attributes which make up the composite key--- LnpRecordKey, InspectionId and CycleCount ---for the Time Recording Transactions resource and used to uniquely identify an instance of Time Recording Transactions. The client should not generate the hash key value. Instead, the client should query on the Time Recording Transactions collection resource with a filter on the primary key values in order to navigate to a specific instance of Time Recording Transactions.

For example: publicSectorTimeRecordingTransactions?q=LnpRecordKey=<value1>;InspectionId=<value2>;CycleCount=<value3>

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

Metadata-Context: string

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

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.

There's no request body for this operation.

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 : publicSectorTimeRecordingTransactions-item-response

Type: object

Show Source

Address1: string

Title: Address

Read Only: true

Maximum Length: 240

The first line of the address.
Address2: string

Read Only: true

Maximum Length: 240

The second line of the address.
Address3: string

Read Only: true

Maximum Length: 240

The third line of the address.
Address4: string

Read Only: true

Maximum Length: 240

The fourth line of the address.
BuildingType: string

Read Only: true

Maximum Length: 20

The building type of the primary parcel address.
City: string

Title: City

Read Only: true

Maximum Length: 60

The city for the primary parcel address.
Classification: string

Read Only: true

Maximum Length: 3

The classification of the application record.
CoordinateX: number

Read Only: true

The x coordinate of the primary parcel address.
CoordinateY: number

Read Only: true

The y coordinate of the primary parcel address.
Country: string

Read Only: true

Maximum Length: 60

The country of the primary parcel address.
County: string

Read Only: true

Maximum Length: 60

The county of the primary parcel address.
CreationDate: string (date-time)

Read Only: true

The date and time when the transaction was created.
CrossroadOne: string

Read Only: true

Maximum Length: 240

The first crossroad of the primary parcel address.
CrossroadTwo: string

Read Only: true

Maximum Length: 240

The second crossroad of the primary parcel address.
CycleCount: number

Read Only: true

The numbering for a plan review cycle.
Floor: string

Read Only: true

Maximum Length: 20

The floor of the primary parcel address.
InspectionId: string

Read Only: true

Maximum Length: 50

The unique identifier for an inspection.
Landmark: string

Read Only: true

Maximum Length: 200

The landmark of the primary parcel address.
LastRecordedDate: string (date)

Read Only: true

The last date when the entered time occurred.
Latitude: number

Read Only: true

The latitude of the primary parcel address.
links: array Links

Title: Links

The link relations associated with the resource instance.
LnpRecordId: string

Title: Application ID

Read Only: true

Maximum Length: 255

The unique identifier for the application record.
LnpRecordKey: integer (int64)

Read Only: true

The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
Longitude: number

Read Only: true

The longitude of the primary parcel address.
PersonId: integer (int64)

Read Only: true

The unique identifier for the agency staff associated with the time recording entry.
PostalCode: string

Title: Postal Code

Read Only: true

Maximum Length: 60

The postal code for the primary parcel address.
PostalPlus4Code: string

Read Only: true

Maximum Length: 20

The postal plus 4 code of the primary parcel address.
Province: string

Read Only: true

Maximum Length: 60

The province of the primary parcel address.
RecordType: string

Title: Application Type

Read Only: true

Maximum Length: 100

The user-friendly name for the application record type.
Source: string

Read Only: true

Maximum Length: 7

The source of the time recording. It can be ORA_INS for inspection, or ORA_PR for plan review.
SourceDesc: string

Read Only: true

Maximum Length: 255

The source description derived from the source attribute value. Used only for export operations.
SourceMeaning: string

Read Only: true

Maximum Length: 255

The meaning of the code stored in the source attribute. Used only for export operations.
State: string

Title: State

Read Only: true

Maximum Length: 60

The state for the primary parcel address.
Status: string

Title: Status

Read Only: true

Maximum Length: 15

The application record status.
StreetDirection: string

Read Only: true

Maximum Length: 10

The street direction of the primary parcel address.
StreetName: string

Read Only: true

Maximum Length: 240

The street name of the primary parcel address.
StreetNameConcat: string

Read Only: true

Maximum Length: 350

The street number and name of the primary parcel address.
StreetNumber: string

Read Only: true

Maximum Length: 20

The street number of the primary parcel address.
StreetNumberAlpha: string

Read Only: true

Maximum Length: 20

The street number of the primary parcel address in alphabetical format.
StreetNumberNumeric: number

Read Only: true

The street number of the primary parcel address in numeric format.
StreetSuffix: string

Read Only: true

Maximum Length: 20

The street suffix of the primary parcel address that further describes the street like Drive, Avenue, etc.
StreetType: string

Read Only: true

Maximum Length: 20

The street type of the primary parcel address.
Subclassification: string

Read Only: true

Maximum Length: 10

The subclassification for the record type, which indicates that the pre-application process is included in addition to the hearing process.
SystemStatus: string

Read Only: true

Maximum Length: 15

The predefined system status to which the record status maps.
TotalRecordedHours: number

Read Only: true

The total number of hours recorded for the transaction.
TotalRecordedMinutes: number

Read Only: true

The total number of minutes recorded for the transaction.
UnitNumber: string

Read Only: true

Maximum Length: 30

The unit number of the primary parcel address.

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"Address",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingType":{
            "maxLength":20,
            "type":"string",
            "description":"The building type of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city for the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the application record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "type":"number",
            "description":"The x coordinate of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "type":"number",
            "description":"The y coordinate of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossroadOne":{
            "maxLength":240,
            "type":"string",
            "description":"The first crossroad of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossroadTwo":{
            "maxLength":240,
            "type":"string",
            "description":"The second crossroad of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleCount":{
            "type":"number",
            "description":"The numbering for a plan review cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Floor":{
            "maxLength":20,
            "type":"string",
            "description":"The floor of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Landmark":{
            "maxLength":200,
            "type":"string",
            "description":"The landmark of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastRecordedDate":{
            "type":"string",
            "description":"The last date when the entered time occurred.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for the application record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The unique identifier for the agency staff associated with the time recording entry.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"The postal plus 4 code of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the application record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Source":{
            "maxLength":7,
            "type":"string",
            "description":"The source of the time recording. It can be ORA_INS for inspection, or ORA_PR for plan review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDesc":{
            "maxLength":255,
            "type":"string",
            "description":"The source description derived from the source attribute value. Used only for export operations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"The meaning of the code stored in the source attribute. Used only for export operations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state for the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The application record status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "maxLength":10,
            "type":"string",
            "description":"The street direction of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetName":{
            "maxLength":240,
            "type":"string",
            "description":"The street name of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNameConcat":{
            "maxLength":350,
            "type":"string",
            "description":"The street number and name of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumberAlpha":{
            "maxLength":20,
            "type":"string",
            "description":"The street number of the primary parcel address in alphabetical format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumberNumeric":{
            "type":"number",
            "description":"The street number of the primary parcel address in numeric format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetSuffix":{
            "maxLength":20,
            "type":"string",
            "description":"The street suffix of the primary parcel address that further describes the street like Drive, Avenue, etc.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetType":{
            "maxLength":20,
            "type":"string",
            "description":"The street type of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"The subclassification for the record type, which indicates that the pre-application process is included in addition to the hearing process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The predefined system status to which the record status maps.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRecordedHours":{
            "type":"number",
            "description":"The total number of hours recorded for the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRecordedMinutes":{
            "type":"number",
            "description":"The total number of minutes recorded for the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unit number of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}