Jump to

• Request
• Response

Get all unassessed time recording entries

get

/fscmRestApi/resources/11.13.18.05/publicSectorTimeRecordingUnassessedEntries

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 unassessed time recording entry that matches the specified primary key criteria.
    Finder Variables:
    • AgencyId; integer; The identifier for the public sector agency associated with the unassessed fees entry.
    • RecordKey; integer; The identifier for the record key associated with the unassessed fees entry.
  • simpleSearchFinder: Finds the time recording unassessed entry that matches the specified criteria.
    Finder Variables:
    • value; string; The keyword used to find a match.
• 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:
  

  • Address1; string; The first address line of the primary parcel address.
  • Address2; string; The second address line of the primary parcel address.
  • Address3; string; The third address line of the primary parcel address.
  • Address4; string; The fourth address line of the primary parcel address.
  • AgencyId; integer; The identifier for the public sector agency associated with the unassessed time recording entry.
  • BuildingType; string; The building type of the primary parcel address.
  • City; string; The city of the primary parcel address.
  • Classification; string; The classification of the application record that the unassessed time recording entry is associated with.
  • CoordinateX; number; The x coordinate of the primary parcel address.
  • CoordinateY; number; The y coordinate of the primary parcel address.
  • Country; string; The country of the primary parcel address.
  • County; string; The county of the primary parcel address.
  • CrossroadOne; string; The first crossroad of the primary parcel address.
  • CrossroadTwo; string; The second crossroad of the primary parcel address.
  • Floor; string; The floor of the primary parcel address.
  • Landmark; string; The landmark of the primary parcel address.
  • Latitude; number; The latitude of the primary parcel address.
  • Longitude; number; The longitude of the primary parcel address.
  • PostalCode; string; The postal code of the primary parcel address.
  • PostalPlus4Code; string; The postal plus 4 code of the primary parcel address.
  • Province; string; The province of the primary parcel address.
  • RecordId; string; The unique identifier for the type of record that the unassessed time recording entry is associated with.
  • RecordKey; integer; The unique identifier for the record that the unassessed time recording entry is associated with.
  • RecordStatus; string; The current status of the record associated with the unassessed time recording entry.
  • RecordType; string; The name of the type of record that the unassessed time recording entry is associated with.
  • State; string; The state of the primary parcel address.
  • StreetDirection; string; The street direction of the primary parcel address.
  • StreetName; string; The street name of the primary parcel address.
  • StreetNameConcat; string; The street number and name of the primary parcel address.
  • StreetNumber; string; The street number of the primary parcel address.
  • StreetNumberAlpha; string; The street number of the primary parcel address in alphabetical format.
  • StreetNumberNumeric; number; The street number of the primary parcel address in numeric format.
  • StreetSuffix; string; The street suffix of the primary parcel address that further describes the street, like Drive, Avenue, etc.
  • StreetType; string; The street type of the primary parcel address.
  • Subclassification; string; The subclassification for the record type of the application record that the unassessed time recording entry is associated with.
  • UnassessedFees; number; The sum of all the unassessed time fees associated with the record.
  • UnitNumber; string; The unit number of the primary parcel address.
• 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 : publicSectorTimeRecordingUnassessedEntries

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

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

Type: object

Show Source

• Address1: string
  Title: Address

  Read Only: true

  Maximum Length: 240

  The first address line of the primary parcel address.
• Address2: string
  Read Only: true

  Maximum Length: 240

  The second address line of the primary parcel address.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third address line of the primary parcel address.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth address line of the primary parcel address.
• AgencyId: integer
  Read Only: true

  The identifier for the public sector agency associated with the unassessed time recording entry.
• BuildingType: string
  Read Only: true

  Maximum Length: 20

  The building type of the primary parcel address.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city of the primary parcel address.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The classification of the application record that the unassessed time recording entry is associated with.
• CoordinateX: number
  Read Only: true

  The x coordinate of the primary parcel address.
• CoordinateY: number
  Read Only: true

  The y coordinate of the primary parcel address.
• Country: string
  Read Only: true

  Maximum Length: 60

  The country of the primary parcel address.
• County: string
  Read Only: true

  Maximum Length: 60

  The county of the primary parcel address.
• CrossroadOne: string
  Read Only: true

  Maximum Length: 240

  The first crossroad of the primary parcel address.
• CrossroadTwo: string
  Read Only: true

  Maximum Length: 240

  The second crossroad of the primary parcel address.
• Floor: string
  Read Only: true

  Maximum Length: 20

  The floor of the primary parcel address.
• Landmark: string
  Read Only: true

  Maximum Length: 200

  The landmark of the primary parcel address.
• Latitude: number
  Read Only: true

  The latitude of the primary parcel address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Read Only: true

  The longitude of the primary parcel address.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code of the primary parcel address.
• PostalPlus4Code: string
  Read Only: true

  Maximum Length: 20

  The postal plus 4 code of the primary parcel address.
• Province: string
  Read Only: true

  Maximum Length: 60

  The province of the primary parcel address.
• RecordId: string
  Title: Application ID

  Read Only: true

  Maximum Length: 50

  The unique identifier for the type of record that the unassessed time recording entry is associated with.
• RecordKey: integer (int64)
  Read Only: true

  The unique identifier for the record that the unassessed time recording entry is associated with.
• RecordStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 15

  The current status of the record associated with the unassessed time recording entry.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The name of the type of record that the unassessed time recording entry is associated with.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state of the primary parcel address.
• StreetDirection: string
  Read Only: true

  Maximum Length: 10

  The street direction of the primary parcel address.
• StreetName: string
  Read Only: true

  Maximum Length: 240

  The street name of the primary parcel address.
• StreetNameConcat: string
  Read Only: true

  Maximum Length: 350

  The street number and name of the primary parcel address.
• StreetNumber: string
  Read Only: true

  Maximum Length: 20

  The street number of the primary parcel address.
• StreetNumberAlpha: string
  Read Only: true

  Maximum Length: 20

  The street number of the primary parcel address in alphabetical format.
• StreetNumberNumeric: number
  Read Only: true

  The street number of the primary parcel address in numeric format.
• StreetSuffix: string
  Read Only: true

  Maximum Length: 20

  The street suffix of the primary parcel address that further describes the street, like Drive, Avenue, etc.
• StreetType: string
  Read Only: true

  Maximum Length: 20

  The street type of the primary parcel address.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification for the record type of the application record that the unassessed time recording entry is associated with.
• UnassessedFees: number
  Read Only: true

  The sum of all the unassessed time fees associated with the record.
• UnitNumber: string
  Read Only: true

  Maximum Length: 30

  The unit number of the primary parcel address.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification for the record type of the application record that the unassessed time recording entry is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetName":{
            "maxLength":"240",
            "type":"string",
            "description":"The street name of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnassessedFees":{
            "type":"number",
            "description":"The sum of all the unassessed time fees associated with the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the unassessed time recording entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record that the unassessed time recording entry is associated with.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The latitude of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":"60",
            "type":"string",
            "description":"The county of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNameConcat":{
            "maxLength":"350",
            "type":"string",
            "description":"The street number and name of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetSuffix":{
            "maxLength":"20",
            "type":"string",
            "description":"The street suffix of the primary parcel address that further describes the street, like Drive, Avenue, etc.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossroadOne":{
            "maxLength":"240",
            "type":"string",
            "description":"The first crossroad of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuildingType":{
            "maxLength":"20",
            "type":"string",
            "description":"The building type of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the type of record that the unassessed time recording entry is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"240",
            "type":"string",
            "description":"The fourth address line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the application record that the unassessed time recording entry is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumberNumeric":{
            "type":"number",
            "description":"The street number of the primary parcel address in numeric format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumber":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the primary parcel address.",
            "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"
            }
        },
        "RecordId":{
            "title":"Application ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the type of record that the unassessed time recording entry is associated with.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The current status of the record associated with the unassessed time recording entry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Floor":{
            "maxLength":"20",
            "type":"string",
            "description":"The floor of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CrossroadTwo":{
            "maxLength":"240",
            "type":"string",
            "description":"The second crossroad of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Landmark":{
            "maxLength":"200",
            "type":"string",
            "description":"The landmark of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"240",
            "type":"string",
            "description":"The third address line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetType":{
            "maxLength":"20",
            "type":"string",
            "description":"The street type of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The longitude of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"60",
            "type":"string",
            "description":"The province of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalPlus4Code":{
            "maxLength":"20",
            "type":"string",
            "description":"The postal plus 4 code of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetDirection":{
            "maxLength":"10",
            "type":"string",
            "description":"The street direction of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":"60",
            "type":"string",
            "description":"The country of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unit number of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateX":{
            "type":"number",
            "description":"The x coordinate of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoordinateY":{
            "type":"number",
            "description":"The y coordinate of the primary parcel address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StreetNumberAlpha":{
            "maxLength":"20",
            "type":"string",
            "description":"The street number of the primary parcel address in alphabetical format.",
            "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