Get a code enforcement inspection
get
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionLists/{publicSectorCodeEnforcementInspectionListsUniqID}
Request
Path Parameters
-
publicSectorCodeEnforcementInspectionListsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TransactionKey and TransactionId ---for the Code Enforcement Inspection Lists resource and used to uniquely identify an instance of Code Enforcement Inspection Lists. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Inspection Lists collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Inspection Lists.
For example: publicSectorCodeEnforcementInspectionLists?q=TransactionKey=<value1>;TransactionId=<value2>
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:
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 TopResponse
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.
Root Schema : publicSectorCodeEnforcementInspectionLists-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The identifier of the public sector agency. -
AssignedCodeOfficerName: string
Read Only:
true
Maximum Length:240
The name of the assigned code officer for the inspection. -
AssignedCodeTechnicianName: string
Read Only:
true
Maximum Length:240
The name of the assigned code technician for the inspection. -
AssignedId: integer
(int64)
Read Only:
true
The identifier of the Code Enforcement officer. -
ComplianceDueDate: string
(date)
Read Only:
true
The identifier of the compliance due date of the case. -
DistrictId: string
Read Only:
true
Maximum Length:30
The identifier of the district where the property is located. -
EarlyInspection: string
Read Only:
true
Maximum Length:1
Indicates whether this inspection is marked for early inspection or not. -
InspectionActDate: string
Read Only:
true
Maximum Length:10
The date on which the inspection was actually carried out. -
InspectionActualDate: string
(date)
Read Only:
true
The date on which the inspection was actually carried out. -
InspectionCount: integer
(int32)
Read Only:
true
The identifier of the count of the inspections carried out in relation to an incident or case. -
InspectionCountName: string
Read Only:
true
Maximum Length:50
The count of the inspection. -
InspectionDueBy: string
(date)
Read Only:
true
The date on which the inspection is due. -
InspectionDueDate: string
Read Only:
true
Maximum Length:10
The date on which the inspection is due. -
InspectionOutcome: string
Read Only:
true
Maximum Length:15
The identifier of the outcome of the inspection. -
InspectionOutcomeReason: string
Read Only:
true
Maximum Length:100
The identifier of the reason for the inspection outcome. -
InspectionReady: string
Read Only:
true
Maximum Length:18
Indicates the ready status of the inspection. -
InspectionReadyEarly: string
Read Only:
true
Maximum Length:80
Indicates the case is ready early for the inspection. -
InspectionSchDate: string
Read Only:
true
Maximum Length:10
The date on which the inspection is scheduled. The format of the value uses the character type. -
InspectionScheduleDate: string
(date)
Read Only:
true
The date on which the inspection is scheduled. -
InspectionStatus: string
Read Only:
true
Maximum Length:1
The identifier of the inspections status. -
InspectionStatusName: string
Read Only:
true
Maximum Length:80
The status of the inspection. -
IntakeKey: integer
(int64)
Read Only:
true
The unique identifier of the incident or the case. -
IssueDescription: string
Read Only:
true
Maximum Length:1000
The description of the issue being processed. -
IssueSubtype: string
Read Only:
true
Maximum Length:100
The identifier of the issue subcategory that is being processed. -
IssueSubtypeCode: string
Read Only:
true
Maximum Length:40
The identifier of the issue subcategory that is being processed. -
IssueSubtypeId: string
Read Only:
true
Maximum Length:50
The unique identifier of the issue subcategory that is being processed. -
IssueType: string
Read Only:
true
Maximum Length:100
The identifier of the issue category that is being processed. -
IssueTypeId: string
Read Only:
true
Maximum Length:50
The unique identifier of the issue category that is being processed. -
Latitude: number
Read Only:
true
The latitude value of the location of the property. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Read Only:
true
The longitude value of the location of the property. -
Priority: string
Read Only:
true
Maximum Length:4
The identifier for the priority of the incident or case. -
PropertyAddress1: string
Read Only:
true
Maximum Length:240
The address 1 of the property. -
PropertyAddress2: string
Read Only:
true
Maximum Length:240
The address 2 of the property. -
PropertyAddress3: string
Read Only:
true
Maximum Length:240
The address 3 of the property. -
PropertyAddress4: string
Read Only:
true
Maximum Length:240
The address 4 of the property. -
PropertyAddressId: integer
(int64)
Read Only:
true
The unique identifier of the address of the property that is being inspected. -
PropertyCity: string
Read Only:
true
Maximum Length:60
The name of the city where the property is located. -
PropertyCoordinateX: number
Read Only:
true
The X coordinate value of the location of the property. -
PropertyCoordinateY: number
Read Only:
true
The Y coordinate value of the location of the property. -
PropertyCountry: string
Read Only:
true
Maximum Length:3
The name of the country where in the property is located. -
PropertyCounty: string
Read Only:
true
Maximum Length:60
The name of the county where in the property is located. -
PropertyParcelId: integer
(int64)
Read Only:
true
The unique id of the parcel of land where the property is located. -
PropertyPostalCode: string
Read Only:
true
Maximum Length:60
The postal code of the area where the property is located. -
PropertyPostalPlusFourCode: string
Read Only:
true
Maximum Length:10
The identifier of the postal code of the area where the property is located. -
PropertyProvince: string
Read Only:
true
Maximum Length:60
The name of the province where in the property is located. -
PropertyState: string
Read Only:
true
Maximum Length:60
The name of the state where in the property is located. -
ReferralCode: string
Read Only:
true
Maximum Length:100
The identifier of the agency to which the incident is referred to. -
ReviewerId: integer
(int64)
Read Only:
true
The identifier of the code enforcement technician. -
SourceTransactionId: string
Read Only:
true
Maximum Length:50
The unique identifier of the source transaction from which the inspection originated. -
SourceTransactionKey: integer
(int64)
Read Only:
true
The auto generated unique identifier of the source transaction from which the inspection originated. -
SourceTransactionStatusName: string
Read Only:
true
Maximum Length:30
The source transaction status of the inspection. -
SourceTransactionType: string
Read Only:
true
Maximum Length:15
Indicates the transaction type from which the inspection originated. -
Status: string
Read Only:
true
Maximum Length:15
The identifier for the status of the incident or case. -
TransactionId: string
Read Only:
true
Maximum Length:50
The unique identifier of the inspection. -
TransactionKey: integer
Read Only:
true
The unique identifier of the inspection that is automatically generated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.