Update an inspection
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspections/{publicSectorCodeEnforcementInspectionsUniqID}
Request
Path Parameters
-
publicSectorCodeEnforcementInspectionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TransactionKey and TransactionId ---for the Code Enforcement Inspections resource and used to uniquely identify an instance of Code Enforcement Inspections. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Inspections collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Inspections.
For example: publicSectorCodeEnforcementInspections?q=TransactionKey=<value1>;TransactionId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdditionalPayload: string
Indicates the additional payload for the inspection outcome.
-
AssignedId: integer
(int64)
Title:
Assigned To
The identifier of the Code Enforcement officer. -
CaseComplianceDate: string
(date)
The date by which the case needs to be complied on.
-
ExtensionDate: string
(date)
The new inspection due date.
-
InspectionActDate: string
(date)
Title:
Inspection Completion Date
The date on which the inspection was actually carried out. -
InspectionDueDate: string
(date)
Title:
Due Date
The date on which the inspection is due. -
InspectionOutcome: string
Title:
Inspection Outcome
Maximum Length:15
The outcome of the inspection. -
InspectionOutcomeReason: string
Title:
Outcome Reason
Maximum Length:100
The reason for the inspection outcome. -
InspectionSchDate: string
(date)
Title:
Scheduled Date
The date on which the inspection is scheduled. -
InspectionStatus: string
Title:
Inspection Status
Maximum Length:8
The identifier of the inspections status. -
NextInsSchDate: string
(date)
The new inspection schedule date.
-
ResultedBy: string
Maximum Length:
64
The name of the user who resulted the inspection. -
SourceTransactionPuid: string
Maximum Length:
480
The legacy system source transaction identifier for the migrated data. -
StopNoticeFlag: string
Maximum Length:
80
Indicates if the notice of violation needs to be generated or not. -
TransactionPuid: string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
UpdateAllComplyFlag: string
Maximum Length:
80
Indicates if the new compliance date needs to be updated for all the code violations or not. -
UserName: string
Maximum Length:
64
The legacy system user assigned to the inspection transaction.
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.
Root Schema : publicSectorCodeEnforcementInspections-item-response
Type:
Show Source
object
-
AdditionalPayload: string
Indicates the additional payload for the inspection outcome.
-
AgencyId: integer
(int32)
Default Value:
1
The identifier of the public sector agency. -
AssignedId: integer
(int64)
Title:
Assigned To
The identifier of the Code Enforcement officer. -
CaseComplianceDate: string
(date)
The date by which the case needs to be complied on.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
ExtensionCount: integer
Read Only:
true
The number of extensions applied for a case. -
ExtensionDate: string
(date)
The new inspection due date.
-
InspectionActDate: string
(date)
Title:
Inspection Completion Date
The date on which the inspection was actually carried out. -
InspectionCount: integer
(int32)
Title:
Inspection Count
The number of inspections conducted for an incident or a case. -
InspectionDueDate: string
(date)
Title:
Due Date
The date on which the inspection is due. -
InspectionOutcome: string
Title:
Inspection Outcome
Maximum Length:15
The outcome of the inspection. -
InspectionOutcomeReason: string
Title:
Outcome Reason
Maximum Length:100
The reason for the inspection outcome. -
InspectionSchDate: string
(date)
Title:
Scheduled Date
The date on which the inspection is scheduled. -
InspectionStatus: string
Title:
Inspection Status
Maximum Length:8
The identifier of the inspections status. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextInsSchDate: string
(date)
The new inspection schedule date.
-
ResultedBy: string
Maximum Length:
64
The name of the user who resulted the inspection. -
SourceTransactionId: string
Title:
Source Transaction Code
Maximum Length:50
Default Value:D
The unique identifier of the source transaction from which the inspection originated. -
SourceTransactionKey: integer
(int64)
Title:
Source Transaction Key
Default Value:0
The auto generated unique identifier of the source transaction from which the inspection originated. -
SourceTransactionPuid: string
Maximum Length:
480
The legacy system source transaction identifier for the migrated data. -
SourceTransactionStatus: string
Read Only:
true
Maximum Length:15
The status of the source transaction after the inspection due date is extended. -
SourceTransactionType: string
Title:
Source Transaction Type
Maximum Length:15
Indicates the transaction type from which the inspection originated. -
StopNoticeFlag: string
Maximum Length:
80
Indicates if the notice of violation needs to be generated or not. -
TransactionId: string
Title:
Inspection Code
Maximum Length:50
Default Value:NEXT
The unique identifier of the inspection. -
TransactionKey: integer
(int64)
The auto generated unique identifier of the inspection.
-
TransactionPuid: string
Maximum Length:
480
The legacy system inspection transaction identifier for the migrated data. -
UpdateAllComplyFlag: string
Maximum Length:
80
Indicates if the new compliance date needs to be updated for all the code violations or not. -
UserName: string
Maximum Length:
64
The legacy system user assigned to the inspection transaction.
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.