Jump to

• Request
• Response

Create an item in the payment cart

post

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCarts

Create an item in the payment cart

Request

Supported Media Types

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

Body ()

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

Root 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

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root 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