REST API for Oracle Public Sector Permitting and Licensing

Get all items from the cart record

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordCarts

Request

Query Parameters

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
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- PrimaryKey: Finds an application that matches the primary key specified.
  Finder Variables:
  - LnpRecordKey; integer; The unique identifier for an application such as a permit application or planning application.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
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
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

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

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- Address1; string; The first line of the applicant address.
- Address2; string; The second line of the applicant address.
- Address3; string; The third line of the applicant address.
- Address4; string; The fourth line of the applicant address.
- Amount; number; The total fees from the source record.
- Applicant; integer; The user who submitted the application.
- City; string; The city of the applicant address.
- Country; string; The applicant country.
- County; string; The country of the applicant address.
- EmailAddress1; string; The applicant first email address.
- EmailAddress2; string; The applicant second email address.
- LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
- LnpRecordKey; integer; The unique identifier for the record key, such as the key for a permit.
- PersonFirstName; string; The applicant first name.
- PersonLastName; string; The applicant last name.
- PersonMiddleName; string; The applicant middle name.
- PersonName; string; The applicant full name.
- PhoneNumber; string; The applicant phone number.
- PostalCode; string; The postal code of the applicant address.
- PostalPlus4Code; string; The postal plus code of the applicant address.
- ProjectKey; integer; The project key associated with this record.
- Province; string; The province of the applicant address.
- RecordType; string; The record type, such as a permit, business license, professional license, or planning and zoning record.
- RecordTypeId; string; The unique identifier for the record type associated with this item.
- State; string; The state of the applicant address.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordCarts-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object publicSectorRecordCarts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordCarts-item-response"
    }
}

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

Type: object

Show Source

Address1: string

Title: Address Line 1

Read Only: true

Maximum Length: 240

The first line of the applicant address.
Address2: string

Title: Address Line 2

Read Only: true

Maximum Length: 240

The second line of the applicant address.
Address3: string

Title: Address Line 3

Read Only: true

Maximum Length: 240

The third line of the applicant address.
Address4: string

Title: Address Line 4

Read Only: true

Maximum Length: 240

The fourth line of the applicant address.
Amount: number

Title: Amount

Read Only: true

The total fees from the source record.
Applicant: integer (int64)

Title: Applicant

Read Only: true

The user who submitted the application.
City: string

Title: City

Read Only: true

Maximum Length: 60

The city of the applicant address.
Country: string

Title: Country

Read Only: true

Maximum Length: 3

The applicant country.
County: string

Title: County

Read Only: true

Maximum Length: 60

The country of the applicant address.
EmailAddress1: string

Title: Email 1

Read Only: true

Maximum Length: 320

The applicant first email address.
EmailAddress2: string

Title: Email 2

Read Only: true

Maximum Length: 320

The applicant second email address.
links: array Links

Title: Links

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

Title: Application

Read Only: true

Maximum Length: 50

The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
LnpRecordKey: integer

Title: Record

Read Only: true

The unique identifier for the record key, such as the key for a permit.
PersonFirstName: string

Title: First Name

Read Only: true

Maximum Length: 150

The applicant first name.
PersonLastName: string

Title: Last Name

Read Only: true

Maximum Length: 150

The applicant last name.
PersonMiddleName: string

Title: Middle Name

Read Only: true

Maximum Length: 60

The applicant middle name.
PersonName: string

Title: Name

Read Only: true

Maximum Length: 450

The applicant full name.
PhoneNumber: string

Title: Phone

Read Only: true

Maximum Length: 60

The applicant phone number.
PostalCode: string

Title: Postal Code

Read Only: true

Maximum Length: 60

The postal code of the applicant address.
PostalPlus4Code: string

Title: Postal Plus 4 Code

Read Only: true

Maximum Length: 10

The postal plus code of the applicant address.
ProjectKey: integer (int64)

Title: Project

Read Only: true

The project key associated with this record.
Province: string

Title: Province

Read Only: true

Maximum Length: 60

The province of the applicant address.
RecordType: string

Title: Application Type

Read Only: true

Maximum Length: 100

The record type, such as a permit, business license, professional license, or planning and zoning record.
RecordTypeId: string

Read Only: true

Maximum Length: 30

The unique identifier for the record type associated with this item.
State: string

Title: State

Read Only: true

Maximum Length: 60

The state of the applicant address.

{
    "type":"object",
    "properties":{
        "ProjectKey":{
            "title":"Project",
            "type":"integer",
            "description":"The project key associated with this record.",
            "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 of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Email 1",
            "maxLength":"320",
            "type":"string",
            "description":"The applicant first email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress2":{
            "title":"Email 2",
            "maxLength":"320",
            "type":"string",
            "description":"The applicant second email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The applicant middle name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The country of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":"100",
            "type":"string",
            "description":"The record type, such as a permit, business license, professional license, or planning and zoning record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "title":"Address Line 4",
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type associated with this item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LnpRecordId":{
            "title":"Application",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":"450",
            "type":"string",
            "description":"The applicant full name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The total fees from the source record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "title":"Address Line 3",
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The applicant first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Record",
            "type":"integer",
            "description":"The unique identifier for the record key, such as the key for a permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "title":"Postal Plus 4 Code",
            "maxLength":"10",
            "type":"string",
            "description":"The postal plus code of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The applicant country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"60",
            "type":"string",
            "description":"The applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "title":"Applicant",
            "type":"integer",
            "description":"The user who submitted the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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."
        }
    }
}