Jump to

• Request
• Response

Get all code enforcement inspections

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionLists

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 inspection row that matches the specified primary key criteria.
    Finder Variables:
    • TransactionId; string; The identifier of the inspection for the person the row is created.
    • TransactionKey; integer; The key identifier of the inspection for the person the row is created.
  • jobAttributeFilterFinder: Finds the inspection that matches the specified search criteria based on the job attributes of the logged in code officer.
    Finder Variables:
    • OfficerId; integer; Finds the inspection that matches the specified identifier of the logged in code officer.
  • simpleSearchFinder: Finds the inspection that matches the specified keyword.
    Finder Variables:
    • OfficerId; integer; Finds the inspection that matches the specified identifier of the logged in code officer.
    • value; string; Finds the inspection that matches the specified 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:
  

  • AgencyId; integer; The identifier of the public sector agency.
  • AssignedCodeOfficerName; string; The name of the assigned code officer for the inspection.
  • AssignedCodeTechnicianName; string; The name of the assigned code technician for the inspection.
  • AssignedId; integer; The identifier of the Code Enforcement officer.
  • ComplianceDueDate; string; The identifier of the compliance due date of the case.
  • DistrictId; string; The identifier of the district where the property is located.
  • EarlyInspection; string; Indicates whether this inspection is marked for early inspection or not.
  • InspectionActDate; string; The date on which the inspection was actually carried out.
  • InspectionActualDate; string; The date on which the inspection was actually carried out.
  • InspectionCount; integer; The identifier of the count of the inspections carried out in relation to an incident or case.
  • InspectionCountName; string; The count of the inspection.
  • InspectionDueBy; string; The date on which the inspection is due.
  • InspectionDueDate; string; The date on which the inspection is due.
  • InspectionOutcome; string; The identifier of the outcome of the inspection.
  • InspectionOutcomeReason; string; The identifier of the reason for the inspection outcome.
  • InspectionReady; string; Indicates the ready status of the inspection.
  • InspectionReadyEarly; string; Indicates the case is ready early for the inspection.
  • InspectionSchDate; string; The date on which the inspection is scheduled. The format of the value uses the character type.
  • InspectionScheduleDate; string; The date on which the inspection is scheduled.
  • InspectionStatus; string; The identifier of the inspections status.
  • InspectionStatusName; string; The status of the inspection.
  • IntakeKey; integer; The unique identifier of the incident or the case.
  • IssueDescription; string; The description of the issue being processed.
  • IssueSubtype; string; The identifier of the issue subcategory that is being processed.
  • IssueSubtypeCode; string; The identifier of the issue subcategory that is being processed.
  • IssueSubtypeId; string; The unique identifier of the issue subcategory that is being processed.
  • IssueType; string; The identifier of the issue category that is being processed.
  • IssueTypeId; string; The unique identifier of the issue category that is being processed.
  • Latitude; number; The latitude value of the location of the property.
  • Longitude; number; The longitude value of the location of the property.
  • Priority; string; The identifier for the priority of the incident or case.
  • PropertyAddress1; string; The address 1 of the property.
  • PropertyAddress2; string; The address 2 of the property.
  • PropertyAddress3; string; The address 3 of the property.
  • PropertyAddress4; string; The address 4 of the property.
  • PropertyAddressId; integer; The unique identifier of the address of the property that is being inspected.
  • PropertyCity; string; The name of the city where the property is located.
  • PropertyCoordinateX; number; The X coordinate value of the location of the property.
  • PropertyCoordinateY; number; The Y coordinate value of the location of the property.
  • PropertyCountry; string; The name of the country where in the property is located.
  • PropertyCounty; string; The name of the county where in the property is located.
  • PropertyParcelId; integer; The unique id of the parcel of land where the property is located.
  • PropertyPostalCode; string; The postal code of the area where the property is located.
  • PropertyPostalPlusFourCode; string; The identifier of the postal code of the area where the property is located.
  • PropertyProvince; string; The name of the province where in the property is located.
  • PropertyState; string; The name of the state where in the property is located.
  • ReferralCode; string; The identifier of the agency to which the incident is referred to.
  • ReviewerId; integer; The identifier of the code enforcement technician.
  • SourceTransactionId; string; The unique identifier of the source transaction from which the inspection originated.
  • SourceTransactionKey; integer; The auto generated unique identifier of the source transaction from which the inspection originated.
  • SourceTransactionStatusName; string; The source transaction status of the inspection.
  • SourceTransactionType; string; Indicates the transaction type from which the inspection originated.
  • Status; string; The identifier for the status of the incident or case.
  • TransactionId; string; The unique identifier of the inspection.
  • TransactionKey; integer; The unique identifier of the inspection that is automatically generated.
• 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 : publicSectorCodeEnforcementInspectionLists

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

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

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The identifier of the public sector agency.
• AssignedCodeOfficerName: string
  Title: Assigned To

  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)
  Title: Completed On

  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.

{
    "type":"object",
    "properties":{
        "PropertyParcelId":{
            "type":"integer",
            "description":"The unique id of the parcel of land where the property is located.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferralCode":{
            "maxLength":"100",
            "type":"string",
            "description":"The identifier of the agency to which the incident is referred to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionSchDate":{
            "maxLength":"10",
            "type":"string",
            "description":"The date on which the inspection is scheduled. The format of the value uses the character type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCount":{
            "type":"integer",
            "description":"The identifier of the count of the inspections carried out in relation to an incident or case.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude value of the location of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionActualDate":{
            "title":"Completed On",
            "type":"string",
            "description":"The date on which the inspection was actually carried out.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue subcategory that is being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyProvince":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the province where in the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionOutcome":{
            "maxLength":"15",
            "type":"string",
            "description":"The identifier of the outcome of the inspection.",
            "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"
            }
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"The auto generated unique identifier of the source transaction from which the inspection originated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InspectionActDate":{
            "maxLength":"10",
            "type":"string",
            "description":"The date on which the inspection was actually carried out.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The identifier for the status of the incident or case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "maxLength":"4",
            "type":"string",
            "description":"The identifier for the priority of the incident or case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionCountName":{
            "maxLength":"50",
            "type":"string",
            "description":"The count of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude value of the location of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCounty":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the county where in the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyState":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the state where in the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionOutcomeReason":{
            "maxLength":"100",
            "type":"string",
            "description":"The identifier of the reason for the inspection outcome.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the area where the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCity":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the city where the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeTechnicianName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the assigned code technician for the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the inspection that is automatically generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntakeKey":{
            "type":"integer",
            "description":"The unique identifier of the incident or the case.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InspectionReady":{
            "maxLength":"18",
            "type":"string",
            "description":"Indicates the ready status of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "InspectionDueDate":{
            "maxLength":"10",
            "type":"string",
            "description":"The date on which the inspection is due.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplianceDueDate":{
            "type":"string",
            "description":"The identifier of the compliance due date of the case.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionType":{
            "maxLength":"15",
            "type":"string",
            "description":"Indicates the transaction type from which the inspection originated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedId":{
            "type":"integer",
            "description":"The identifier of the Code Enforcement officer.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InspectionStatus":{
            "maxLength":"1",
            "type":"string",
            "description":"The identifier of the inspections status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionReadyEarly":{
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the case is ready early for the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddressId":{
            "type":"integer",
            "description":"The unique identifier of the address of the property that is being inspected.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyAddress2":{
            "maxLength":"240",
            "type":"string",
            "description":"The address 2 of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the source transaction from which the inspection originated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionDueBy":{
            "type":"string",
            "description":"The date on which the inspection is due.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress1":{
            "maxLength":"240",
            "type":"string",
            "description":"The address 1 of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtypeCode":{
            "maxLength":"40",
            "type":"string",
            "description":"The identifier of the issue subcategory that is being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarlyInspection":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this inspection is marked for early inspection or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress4":{
            "maxLength":"240",
            "type":"string",
            "description":"The address 4 of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyAddress3":{
            "maxLength":"240",
            "type":"string",
            "description":"The address 3 of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the issue being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistrictId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the district where the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueSubtype":{
            "maxLength":"100",
            "type":"string",
            "description":"The identifier of the issue subcategory that is being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyPostalPlusFourCode":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the postal code of the area where the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueType":{
            "maxLength":"100",
            "type":"string",
            "description":"The identifier of the issue category that is being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionStatusName":{
            "maxLength":"30",
            "type":"string",
            "description":"The source transaction status of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueTypeId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the issue category that is being processed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionScheduleDate":{
            "type":"string",
            "description":"The date on which the inspection is scheduled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCountry":{
            "maxLength":"3",
            "type":"string",
            "description":"The name of the country where in the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionStatusName":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReviewerId":{
            "type":"integer",
            "description":"The identifier of the code enforcement technician.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PropertyCoordinateY":{
            "type":"number",
            "description":"The Y coordinate value of the location of the property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedCodeOfficerName":{
            "title":"Assigned To",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the assigned code officer for the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyCoordinateX":{
            "type":"number",
            "description":"The X coordinate value of the location of the property.",
            "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