Jump to

• Request
• Response

Get all recent issues

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementRecentIssues

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 the issues that match the specified primary key criteria.
    Finder Variables:
    • CaseKey; integer; The unique identifier of a case.
  • responsiblePartyFinder: Finds the issues that are associated with the current logged in public user.
    Finder Variables:
    • value; string; The filter values to be applied when finding delegate information. Options include incident ID, status, description, property, address, or city.
  • searchByActiveIssue: Finds the issues that are active and match the specified bind variable criteria.
    Finder Variables:
    • endDate; string; Date till which issues have to be retrieved.
    • startDate; string; Date from which issues have to be retrieved.
    • value; string; The unique identifier of a case.
  • searchByIssue: Finds the issues that match the specified primary key criteria.
    Finder Variables:
    • endDate; string; Date till which issues have to be retrieved.
    • startDate; string; Date from which issues have to be retrieved.
    • value; string; The filter values to be applied when finding delegate information. Options include incident ID, status, description, property, address, or city.
  • searchByParcelorAddress: Finds the issues that match the specified bind variable criteria.
    Finder Variables:
    • value; string; The filter values to be applied when finding delegate information. Options include property parcel ID or address ID.
  • simpleSearchFinder: Finds the issues that match the specified bind variable criteria.
    Finder Variables:
    • value; string; The filter values to be applied when finding delegate information. Options include incident ID, status, description, property, address, or city.
• 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:
  

  • AgencyId; integer; The unique agency ID.
  • CaseId; string; The logical ID for a case.
  • CaseKey; integer; The unique identifier for a case. This number is created using autonumbering.
  • ClosedReason; string; The reason for closing the issue.
  • CurrencyCode; string; The currency code of the fees.
  • FunctionalStatus; string; The user defined case status name that maps to a delivered system status.
  • IssueDescription; string; The issue description.
  • IssueSubtype; string; The logical issue subtype.
  • IssueSubtypeId; string; The logical ID for the issue subtype.
  • IssueType; string; The logical issue type.
  • IssueTypeId; string; The logical ID for the issue type.
  • Latitude; number; The latitude of the property that is associated with the issue.
  • Longitude; number; The longitude of the property that is associated with the issue.
  • ParcelIdEntered; string; The Assessor Parcel Number (APN) as entered by the user.
  • PropertyAddress1; string; The first line of the address for the complaint.
  • PropertyAddress2; string; The second line of the address for the complaint.
  • PropertyAddress3; string; The third line of the address for the complaint.
  • PropertyAddress4; string; The fourth line of the address for the complaint.
  • PropertyAddressId; integer; The property address ID.
  • PropertyCity; string; The city for the address of the complaint.
  • PropertyCountry; string; The country for the address of the complaint.
  • PropertyCounty; string; The county of the address of the complaint.
  • PropertyParcelId; integer; The property parcel ID.
  • PropertyPostalCode; string; The postal code for the address of the complaint.
  • PropertyProvince; string; The province for the address of the complaint.
  • PropertyState; string; The state for the address of the complaint.
  • ResponsibleFlag; string; Indicates that the current logged in public user is the responsible party for the issue or case.
  • Status; string; The case status.
  • StatusName; string; The description of the issue status.
  • SubmitDate; string; The date that the issue was submitted.
  • TotalFeeDue; number; The total due fees.
  • TotalPaymentInProcess; number; The total amount which is in process.
• 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:
  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 : publicSectorCodeEnforcementRecentIssues

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

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

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The unique agency ID.
• CaseId: string
  Read Only: true

  Maximum Length: 50

  The logical ID for a case.
• CaseKey: integer
  Read Only: true

  The unique identifier for a case. This number is created using autonumbering.
• ClosedReason: string
  Read Only: true

  Maximum Length: 450

  The reason for closing the issue.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 3

  The currency code of the fees.
• FunctionalStatus: string
  Read Only: true

  Maximum Length: 15

  The user defined case status name that maps to a delivered system status.
• IssueDescription: string
  Read Only: true

  Maximum Length: 1000

  The issue description.
• IssueSubtype: string
  Read Only: true

  Maximum Length: 100

  The logical issue subtype.
• IssueSubtypeId: string
  Read Only: true

  Maximum Length: 50

  The logical ID for the issue subtype.
• IssueType: string
  Read Only: true

  Maximum Length: 100

  The logical issue type.
• IssueTypeId: string
  Read Only: true

  Maximum Length: 50

  The logical ID for the issue type.
• Latitude: number
  Read Only: true

  The latitude of the property that is associated with the issue.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Read Only: true

  The longitude of the property that is associated with the issue.
• ParcelIdEntered: string
  Read Only: true

  Maximum Length: 30

  The Assessor Parcel Number (APN) as entered by the user.
• PropertyAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the address for the complaint.
• PropertyAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the address for the complaint.
• PropertyAddress3: string
  Read Only: true

  Maximum Length: 240

  The third line of the address for the complaint.
• PropertyAddress4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the address for the complaint.
• PropertyAddressId: integer (int64)
  Read Only: true

  The property address ID.
• PropertyCity: string
  Read Only: true

  Maximum Length: 60

  The city for the address of the complaint.
• PropertyCountry: string
  Read Only: true

  Maximum Length: 3

  The country for the address of the complaint.
• PropertyCounty: string
  Read Only: true

  Maximum Length: 60

  The county of the address of the complaint.
• PropertyParcelId: integer (int64)
  Read Only: true

  The property parcel ID.
• PropertyPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code for the address of the complaint.
• PropertyProvince: string
  Read Only: true

  Maximum Length: 60

  The province for the address of the complaint.
• PropertyState: string
  Read Only: true

  Maximum Length: 60

  The state for the address of the complaint.
• ResponsibleFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates that the current logged in public user is the responsible party for the issue or case.
• Status: string
  Read Only: true

  Maximum Length: 15

  The case status.
• StatusName: string
  Read Only: true

  Maximum Length: 30

  The description of the issue status.
• SubmitDate: string (date-time)
  Read Only: true

  The date that the issue was submitted.
• TotalFeeDue: number
  Read Only: true

  The total due fees.
• TotalPaymentInProcess: number
  Read Only: true

  The total amount which is in process.

{
    "type":"object",
    "properties":{
        "PropertyParcelId":{
            "type":"integer",
            "description":"The property parcel ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique agency ID.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SubmitDate":{
            "type":"string",
            "description":"The date that the issue was submitted.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the property that is associated with the issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical ID for the issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedReason":{
            "maxLength":"450",
            "type":"string",
            "description":"The reason for closing the issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency code of the fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The province for the address of the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddressId":{
            "type":"integer",
            "description":"The property address ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second line of the address for the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelIdEntered":{
            "maxLength":"30",
            "type":"string",
            "description":"The Assessor Parcel Number (APN) as entered by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The first line of the address for the complaint.",
            "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"
            }
        },
        "TotalFeeDue":{
            "type":"number",
            "description":"The total due fees.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth line of the address for the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third line of the address for the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The case status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The user defined case status name that maps to a delivered system status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The issue description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier for a case. This number is created using autonumbering.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueType":{
            "maxLength":"100",
            "type":"string",
            "description":"The logical issue type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "maxLength":"100",
            "type":"string",
            "description":"The logical issue subtype.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical ID for the issue type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical ID for a case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusName":{
            "maxLength":"30",
            "type":"string",
            "description":"The description of the issue status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaymentInProcess":{
            "type":"number",
            "description":"The total amount which is in process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The country for the address of the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the property that is associated with the issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The county of the address of the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "maxLength":"60",
            "type":"string",
            "description":"The state for the address of the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponsibleFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the current logged in public user is the responsible party for the issue or case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code for the address of the complaint.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The city for the address of the complaint.",
            "nullable":true,
            "readOnly":true,
            "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