Jump to

• Request
• Response

Get a payment cart item

get

/fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems/{CartId}

Request

Path Parameters

• CartId(required): integer(int64)
  The unique identifier for the current payment cart.

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.

Back to Top

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.

Body ()

Root Schema : publicSectorPaymentCartItems-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first line of the address in the application.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second line of the address in the application, if present.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third line of the address in the application, if present.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the address in the application, if present.
• AgencyId: integer (int32)
  Read Only: true

  The unique identifier for the public sector agency.
• Amount: string
  Read Only: true

  The total fee amount for the cart item.
• Applicant: integer (int64)
  Read Only: true

  The user identification number of the applicant who submitted the application.
• ApplicantName: string
  Read Only: true

  Maximum Length: 450

  The name of the applicant who submitted the application.
• AssociatedProject: 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.
• BusDbaBusinessName: string
  Read Only: true

  Maximum Length: 100

  Business name registered as a doing business as, or DBA name, with an agency.
• CartAmount: number
  Read Only: true

  The initial amount due when an item is added to the payment cart.
• CartId: integer (int64)
  Read Only: true

  The unique identifier for the current payment cart.
• CartItemType: string
  Read Only: true

  Maximum Length: 3

  The record type of the cart item, such as a permit, business license, professional license, or planning and zoning.
• CartOwner: integer (int64)
  Read Only: true

  The identifier for the user profile associated with the payment cart.
• CartStatus: string
  Read Only: true

  Maximum Length: 10

  The status of the item in the payment cart.
• City: string
  Read Only: true

  Maximum Length: 60

  The city in the application address.
• Country: string
  Read Only: true

  Maximum Length: 60

  The country in the application address.
• County: string
  Read Only: true

  Maximum Length: 60

  The county in the application address.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 3

  The currency code of the payment.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The details related to the cart item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Originator: string
  Read Only: true

  Maximum Length: 3

  The user who submitted the record.
• PaymentInProcess: number
  Read Only: true

  The amount stuck in the payment in processing status.
• PhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The phone number of the applicant who submitted the application.
• PostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code in the application address.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 20

  The extended postal code in the application address.
• PrimaryContact: string
  Read Only: true

  Maximum Length: 450

  The name of the primary contact as mentioned in the application.
• ProjectKey: integer (int64)
  Read Only: true

  The unique identifier for the project associated with the application.
• Province: string
  Read Only: true

  Maximum Length: 60

  The province in the application address.
• RecordId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the record.
• RecordKey: integer (int64)
  Read Only: true

  The unique identifier of the record, such as the key for a permit.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The record type of the application.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 100

  The unique identifier for the record type of the application.
• State: string
  Read Only: true

  Maximum Length: 60

  The state in the application address.
• SubmitDate: string (date-time)
  Read Only: true

  The date when the record was submitted.
• TotalDueCount: number
  Read Only: true

  The total count of the fee items associated with the application that are due.

{
    "type":"object",
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address in the application, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the address in the application, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the address in the application, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for the public sector agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Amount":{
            "type":"string",
            "description":"The total fee amount for the cart item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The user identification number of the applicant who submitted the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the applicant who submitted the  application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociatedProject":{
            "title":"Associated Projects",
            "type":"array",
            "description":"The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPaymentCartItems-AssociatedProject-item-response"
            }
        },
        "BusDbaBusinessName":{
            "maxLength":100,
            "type":"string",
            "description":"Business name registered as a doing business as, or DBA name, with an agency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CartAmount":{
            "type":"number",
            "description":"The initial amount due when an item is added to the payment cart.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CartId":{
            "type":"integer",
            "description":"The unique identifier for the current payment cart.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CartOwner":{
            "type":"integer",
            "description":"The identifier for the user profile associated with the payment cart.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CartStatus":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the item in the payment cart.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":60,
            "type":"string",
            "description":"The country in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of the payment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The details related to the cart item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Originator":{
            "maxLength":3,
            "type":"string",
            "description":"The user who submitted the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentInProcess":{
            "type":"number",
            "description":"The amount stuck in the payment in processing status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the applicant who submitted the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":20,
            "type":"string",
            "description":"The extended postal code in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContact":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the primary contact as mentioned in the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectKey":{
            "type":"integer",
            "description":"The unique identifier for the project associated with the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record, such as the key for a permit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The record type of the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the record type of the application.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the application address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The date when the record was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalDueCount":{
            "type":"number",
            "description":"The total count of the fee items associated with the application that are due.",
            "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 : 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 publicSectorPaymentCartItems-AssociatedProject-item-response

{
    "title":"Associated Projects",
    "type":"array",
    "description":"The associated projects resource is used to retrieve project information associated with the permit that was added to the payment cart.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPaymentCartItems-AssociatedProject-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 : publicSectorPaymentCartItems-AssociatedProject-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for a project.
• ProjectName: string
  Read Only: true

  Maximum Length: 50

  The user-friendly name for a project.
• RecordKey: integer (int64)
  Read Only: true

  The unique identifier of the record, such as the key for a permit.

{
    "type":"object",
    "properties":{
        "ProjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectName":{
            "maxLength":50,
            "type":"string",
            "description":"The user-friendly name for a project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record, such as the key for a permit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Links

AssociatedProject

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorPaymentCartItems/{CartId}/child/AssociatedProject

Parameters:

• CartId: $request.path.CartId

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

Back to Top