Jump to

• Request
• Response

Get all payment cart items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 a payment cart item using the primary keys. Finder Variables:
    • AgencyId; integer; The unique identifier of the current agency.
    • CartId; integer; The unique identifier of the current payment cart item.
    • CartOwner; integer; The unique identifier for the current payment cart owner.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPaymentCarts

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorPaymentCarts-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPaymentCarts-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPaymentCarts-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorPaymentCarts-item

Type: object

Show Source

• AddedToCartOn(optional): string(date-time)
  The date when the item was added to the payment cart.
• AgencyId(optional): integer(int32)
  The identifier for the public sector agency.
• Amount(optional): number
  Title: Amount

  The total fees for the permit.
• Applicant(optional): integer(int64)
  The user who submitted the permit application.
• ApplicantName(optional): string
  Maximum Length: 450

  The name of the permit applicant.
• AssociatedProject(optional): array Associated Projects
  Title: Associated Projects

  The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.
• CartId(optional): integer(int64)
  The unique identifier for the current payment cart.
• CartItemType(optional): string
  Maximum Length: 3

  The record type of the cart item, such as a permit, business license, professional license, or planning and zoning record.
• CartOwner(optional): integer(int64)
  The identifier for user profile associated with the payment cart.
• CartStatus(optional): string
  Maximum Length: 10

  The status of the payment cart item.
• CurrencyCode(optional): string
  Maximum Length: 3

  The payment currency code.
• links(optional): array Items
  Title: Items

  Link Relations
• Originator(optional): string
  Maximum Length: 3

  The user who submitted the permit.
• RecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The record identifier for the permit.
• RecordKey(optional): integer(int64)
  The unique identifier for the record key, such as the key for a permit.

{
    "properties":{
        "AddedToCartOn":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the item was added to the payment cart."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier for the public sector agency."
        },
        "Amount":{
            "type":"number",
            "description":"The total fees for the permit.",
            "title":"Amount"
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The user who submitted the permit application."
        },
        "ApplicantName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the permit applicant."
        },
        "AssociatedProject":{
            "items":{
                "$ref":"#/definitions/publicSectorPaymentCarts-AssociatedProject-item"
            },
            "type":"array",
            "description":"The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.",
            "title":"Associated Projects"
        },
        "CartId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the current payment cart."
        },
        "CartItemType":{
            "maxLength":3,
            "type":"string",
            "description":"The record type of the cart item, such as a permit, business license, professional license, or planning and zoning record."
        },
        "CartOwner":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for user profile associated with the payment cart."
        },
        "CartStatus":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the payment cart item."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The payment currency code."
        },
        "Originator":{
            "maxLength":3,
            "type":"string",
            "description":"The user who submitted the permit."
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The record identifier for the permit.",
            "title":"Record ID"
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the record key, such as the key for a permit."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Associated Projects

Type: array

Title: Associated Projects

The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.

Show Source

• Array of: object publicSectorPaymentCarts-AssociatedProject-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPaymentCarts-AssociatedProject-item"
    },
    "type":"array",
    "description":"The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.",
    "title":"Associated Projects"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorPaymentCarts-AssociatedProject-item

Type: object

Show Source

• links(optional): array Items
  Title: Items

  Link Relations
• ProjectCode(optional): string
  Maximum Length: 30

  The unique identifier for a project.
• ProjectName(optional): string
  Maximum Length: 50

  The user-friendly name for a project.
• RecordKey(optional): integer(int64)
  The unique identifier for the record key, such as the key for a permit.

{
    "properties":{
        "ProjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a project."
        },
        "ProjectName":{
            "maxLength":50,
            "type":"string",
            "description":"The user-friendly name for a project."
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the record key, such as the key for a permit."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top