Jump to

• Request
• Response

Get all transactions

get

/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLists

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:
  
  

  • ActiveList: Finds all active transactions.
    Finder Variables:
    • bParcelIdEntered; string; Identifier for the transaction belonging to the same parcel.
  • PrimaryKey: Finds the transaction that matches the primary key criteria.
    Finder Variables:
    • LnpRecordKey; integer; The unique identifier of the transaction.
  • SimpleSearchAllFinder: Finds all active transactions.
    Finder Variables:
    • value; string; Finds transactions that match the primary search value.
  • SimpleSearchFinder: Finds transactions that match the primary search criteria.
    Finder Variables:
    • bParcelIdEntered; string; Identifier for the transaction belonging to the same parcel.
    • value; string; Finds transactions that match the primary search value.
• 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 or main address.
  • Address2; string; The second address, if present.
  • Address3; string; The third address, if present.
  • Address4; string; The fourth address, if present.
  • Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
  • City; string; The city in the parcel address.
  • ClassDesc; string; The classification description of the transaction like permit, planning and zoning, or business license.
  • Classification; string; The classification of the transaction like ORA_PMT, ORA_PZ, and ORA_LIC.
  • Description; string; The transaction description.
  • ExpirationDate; string; The date when the application expires.
  • IssueDate; string; The date when the application was issued.
  • LnpRecordId; string; The unique identifier for an application transaction. This identifier is automatically generated based on the rules configured for the record type.
  • LnpRecordKey; integer; The unique identifier for a transaction. The transaction is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
  • ParcelIdEntered; string; The parcel ID of the application.
  • RecordNumber; string; The public unique identifier of the migrated record.
  • RecordType; string; The user-friendly name for the record type.
  • RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
  • RecordTypeId; string; The unique identifier for a record type.
  • State; string; The state in the parcel address.
  • Status; string; The status of the transaction.
  • SubClassDesc; string; The subclassification description of the transaction like Pre-application, Consultation, or none.
  • Subclassification; string; The subclassification of the transaction like ORA_PREAPP, ORA_CON, and ORA_NA.
  • SubmitDate; string; The date when the record was submitted.
  • SystemStatus; string; The predefined system status to which the record status maps.
  • VersionType; string; The version of the permit. Values are original, amendment, and renewal.
  • VersionTypeDesc; string; The description for the version type.
• 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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorTransactionLists

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/publicSectorTransactionLists-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 publicSectorTransactionLists-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorTransactionLists-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 : publicSectorTransactionLists-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240

  The first or main address.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second address, if present.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third address, if present.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth address, if present.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
• City: string
  Read Only: true

  Maximum Length: 60

  The city in the parcel address.
• ClassDesc: string
  Read Only: true

  Maximum Length: 80

  The classification description of the transaction like permit, planning and zoning, or business license.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the transaction like ORA_PMT, ORA_PZ, and ORA_LIC.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The transaction description.
• ExpirationDate: string (date-time)
  Read Only: true

  The date when the application expires.
• IssueDate: string (date-time)
  Read Only: true

  The date when the application was issued.
• links: array Links
  Title: Links

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

  Maximum Length: 50

  The unique identifier for an application transaction. This identifier is automatically generated based on the rules configured for the record type.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for a transaction. The transaction is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• ParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The parcel ID of the application.
• RecordNumber: string
  Read Only: true

  Maximum Length: 64

  The public unique identifier of the migrated record.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The user-friendly name for the record type.
• RecordTypeCode: string
  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for the record type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for a record type.
• State: string
  Read Only: true

  Maximum Length: 60

  The state in the parcel address.
• Status: string
  Read Only: true

  Maximum Length: 15

  The status of the transaction.
• SubClassDesc: string
  Read Only: true

  Maximum Length: 80

  The subclassification description of the transaction like Pre-application, Consultation, or none.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification of the transaction like ORA_PREAPP, ORA_CON, and ORA_NA.
• SubmitDate: string (date-time)
  Read Only: true

  The date when the record was submitted.
• SystemStatus: string
  Read Only: true

  Maximum Length: 15

  The predefined system status to which the record status maps.
• VersionType: string
  Read Only: true

  Maximum Length: 1

  The version of the permit. Values are original, amendment, and renewal.
• VersionTypeDesc: string
  Read Only: true

  Maximum Length: 80

  The description for the version type.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"The subclassification of the transaction like ORA_PREAPP, ORA_CON,  and ORA_NA.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The transaction description.",
            "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
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the transaction like ORA_PMT, ORA_PZ, and ORA_LIC.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":30,
            "type":"string",
            "description":"The parcel ID of the application.",
            "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"
            }
        },
        "ClassDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The classification description of the transaction like permit, planning and zoning, or business license.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the transaction.",
            "nullable":false,
            "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
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an application transaction. This identifier is automatically generated based on the rules configured for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "type":"string",
            "description":"The date when the application was issued.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third address, if present.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first or main address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a transaction. The transaction 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
        },
        "VersionType":{
            "maxLength":1,
            "type":"string",
            "description":"The version of the permit. Values are original, amendment, and renewal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionTypeDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The description for the version type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "type":"string",
            "description":"The date when the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubClassDesc":{
            "maxLength":80,
            "type":"string",
            "description":"The subclassification description of the transaction like Pre-application, Consultation, or none.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the migrated record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.",
            "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."
        }
    }
}

Back to Top