Jump to

• Request
• Response

Get a set of mapping attributes

get

/fscmRestApi/resources/11.13.18.05/publicSectorCalculateInspectionFees/{publicSectorCalculateInspectionFeesUniqID}

Request

Path Parameters

• publicSectorCalculateInspectionFeesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Permit Inspection Time Entry Fees resource and used to uniquely identify an instance of Permit Inspection Time Entry Fees. The client should not generate the hash key value. Instead, the client should query on the Permit Inspection Time Entry Fees collection resource in order to navigate to a specific instance of Permit Inspection Time Entry Fees to get the hash key.

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 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 : publicSectorCalculateInspectionFees-item-response

Type: object

Show Source

• BillableFlag: string
  Title: Billable

  Read Only: true

  Maximum Length: 1

  Indicates whether the time entry is billable.
• BillRate: number
  Title: Bill Rate

  Read Only: true

  The hourly billing rate used for this time entry.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 40

  The category for the time entry.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  Indicates whether the time entry is based on a Permit or Planning and Zoning.
• Department: string
  Title: Department

  Read Only: true

  Maximum Length: 240

  The department of the person for whom the time was entered.
• InspectionType: string
  Title: Inspection Type

  Read Only: true

  Maximum Length: 15

  The inspection type for the inspection.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 240

  The job title of the person for whom the time was entered.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PermitType: string
  Title: Mapping Source

  Read Only: true

  Maximum Length: 20

  The permit type of the permit for which the time entry is entered.
• PersonId: integer (int64)
  Title: Person ID

  Read Only: true

  The unique identifier of the person for whom the time was entered.
• PersonName: string
  Title: Person Name

  Read Only: true

  Maximum Length: 240

  The name of the person for whom the time was entered.
• RecordedDate: string (date)
  Title: Date

  Read Only: true

  The date when the time entry was entered.
• RecordedHours: integer (int32)
  Title: Hours

  Read Only: true

  The hours spent for the time entry.
• RecordedMinutes: integer (int32)
  Title: Minutes

  Read Only: true

  The minutes spent for the time entry.
• ReinspectionFlag: string
  Title: Is a Reinspection

  Read Only: true

  Maximum Length: 1

  Indicates whether the inspection is due to a reinspection.
• Subcategory: string
  Title: Subcategory

  Read Only: true

  Maximum Length: 40

  The subcategory for the time entry.
• TransactionSource: string
  Title: Transaction

  Read Only: true

  Maximum Length: 3

  Indicates that the time entry is for an inspection.

{
    "type":"object",
    "properties":{
        "InspectionType":{
            "title":"Inspection Type",
            "maxLength":"15",
            "type":"string",
            "description":"The inspection type for the inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Person Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the person for whom the time was entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PermitType":{
            "title":"Mapping Source",
            "maxLength":"20",
            "type":"string",
            "description":"The permit type of the permit for which the time entry is entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Category":{
            "title":"Category",
            "maxLength":"40",
            "type":"string",
            "description":"The category for the time entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionSource":{
            "title":"Transaction",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates that the time entry is for an inspection.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordedMinutes":{
            "title":"Minutes",
            "type":"integer",
            "description":"The minutes spent for the time entry.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the time entry is billable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":"240",
            "type":"string",
            "description":"The job title of the person for whom the time was entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Department":{
            "title":"Department",
            "maxLength":"240",
            "type":"string",
            "description":"The department of the person for whom the time was entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person for whom the time was entered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordedHours":{
            "title":"Hours",
            "type":"integer",
            "description":"The hours spent for the time entry.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":"40",
            "type":"string",
            "description":"The subcategory for the time entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates whether the time entry is based on a Permit or Planning and Zoning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillRate":{
            "title":"Bill Rate",
            "type":"number",
            "description":"The hourly billing rate used for this time entry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinspectionFlag":{
            "title":"Is a Reinspection",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the inspection is due to a reinspection.",
            "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"
            }
        },
        "RecordedDate":{
            "title":"Date",
            "type":"string",
            "description":"The date when the time entry was entered.",
            "format":"date",
            "nullable":false,
            "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