Get a violation notice
get
/fscmRestApi/resources/11.13.18.05/publicSectorListViolationNotices/{CaseNoticeKey}
Request
Path Parameters
-
CaseNoticeKey: integer
The unique identifier of the case notice.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorListViolationNotices-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency identifier of the case notice.
-
CaseContacts(optional):
array Case Contacts
Title:
Case Contacts
The list violation notice resource is used to view a list of violation notices. Violation notices are used in Code Enforcement cases. -
CaseId(optional):
string
Maximum Length:
50
The unique identifier of the case. -
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
CaseNoticeId(optional):
string
Title:
Notice ID
Maximum Length:50
The unique identifier of the case notice. -
CaseNoticeKey(optional):
integer(int64)
The unique identifier of the case notice.
-
CaseStatus(optional):
string
Title:
Case Status
Maximum Length:15
The status of the case. -
Comments(optional):
string
Title:
Comments
Maximum Length:1000
The comments entered about the case notice. -
ComplianceDueDate(optional):
string(date)
The compliance due date of case.
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
IssueSubtype(optional):
string
Maximum Length:
100
The issue subtype of the case. -
IssueSubtypeId(optional):
string
Maximum Length:
50
The issue subtype identifier of the case notice. -
IssueTypeId(optional):
string
Maximum Length:
50
The issue type identifier of the case notice. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
NoticeSource(optional):
string
Maximum Length:
15
The source of the case notice. -
NoticeStatus(optional):
string
Title:
Status
Maximum Length:15
The status of the case notice. -
NoticeTypeCode(optional):
string
Maximum Length:
100
The notice type identifier of the case notice. -
NoticeTypeName(optional):
string
Title:
Name
Maximum Length:200
The name of notice type. -
PropertyAddress1(optional):
string
Maximum Length:
240
The first line for the address of the property related to the case. -
PropertyAddress2(optional):
string
Maximum Length:
240
The second line for the address of the property related to the case. -
PropertyAddress3(optional):
string
Maximum Length:
240
The third line for the address of the property related to the case. -
PropertyAddress4(optional):
string
Maximum Length:
240
The fourth line for the address of the property related to the case. -
PropertyAddressId(optional):
integer(int64)
The unique identifier of the property address related to the case.
-
PropertyCity(optional):
string
Maximum Length:
60
The city in which the property related to the case is located. -
PropertyCoordinateX(optional):
number
The latitude of the property related to the case.
-
PropertyCoordinateY(optional):
number
The longitude of the property related to the case.
-
PropertyCountry(optional):
string
Maximum Length:
3
The country in which the property related to the case is located. -
PropertyCounty(optional):
string
Maximum Length:
60
The county in which the property related to the case is located. -
PropertyParcelId(optional):
integer(int64)
The unique identifier for the property address of the case.
-
PropertyPostalCode(optional):
string
Maximum Length:
60
The postal code of the property related to the case. -
PropertyPostalPluscode(optional):
string
Maximum Length:
10
The postal plus code of the property related to the case. -
PropertyProvince(optional):
string
Maximum Length:
60
The province in which the property related to the case is located. -
PropertyState(optional):
string
Maximum Length:
60
The state in which the property related to the case is located. -
ReceivedDate(optional):
string(date-time)
Title:
Received Date
The date on which the notice was received. -
ReviewerId(optional):
integer(int64)
The code technician identifier of the case.
-
Sequence(optional):
integer(int32)
The sequence of the case notice.
-
ShippedBy(optional):
string
Title:
Carrier Name
Maximum Length:500
The name of the shipping carrier that is delivering the case notice. -
ShippedDate(optional):
string(date-time)
Title:
Sent Date
Date on which the notice was shipped. -
TrackingId(optional):
string
Title:
Tracking Number
Maximum Length:500
The tracking identifier of the shipping carrier delivering the case notice.
Nested Schema : Case Contacts
Type:
array
Title:
Case Contacts
The list violation notice resource is used to view a list of violation notices. Violation notices are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorListViolationNotices-CaseContacts-item
Type:
Show Source
object
-
Address1(optional):
string
Maximum Length:
240
The first line for the address of the contact related to the case. -
Address2(optional):
string
Maximum Length:
240
The second line for the address of the contact related to the case. -
Address3(optional):
string
Maximum Length:
240
The third line for the address of the contact related to the case. -
Address4(optional):
string
Maximum Length:
240
The fourth line for the address of the contact related to the case. -
CaseContactKey(optional):
integer(int64)
The unique identifier of the case contact.
-
CaseKey(optional):
integer(int64)
The unique identifier of the case.
-
City(optional):
string
Maximum Length:
60
The city in which the contact related to the case is located. -
ContactType(optional):
string
Title:
Type
Maximum Length:15
The type of case contact. -
Country(optional):
string
Maximum Length:
3
The country in which the contact related to the case is located. -
County(optional):
string
Maximum Length:
60
The county in which the contact related to the case is located. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
PersonFirstName(optional):
string
Title:
First Name
Maximum Length:150
The first name of the case contact. -
PersonLastName(optional):
string
Title:
Last Name
Maximum Length:150
The last name of the case contact. -
PersonMiddleName(optional):
string
Title:
Middle Name
Maximum Length:60
The middle name of the case contact. -
PersonNameSuffix(optional):
string
Title:
Name Suffix
Maximum Length:30
The suffix name for the case contact. -
PersonTitle(optional):
string
Title:
Title
Maximum Length:60
The title of case contact name. -
PostalCode(optional):
string
Maximum Length:
60
The postal code of the contact related to the case. -
PostalPlusCode(optional):
string
Maximum Length:
10
The postal plus code of the contact related to the case. -
Province(optional):
string
Maximum Length:
60
The province in which the contact related to the case is located. -
State(optional):
string
Maximum Length:
60
The state in which the contact related to the case is located.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.