Jump to

• Request
• Response

Get all latest transaction assignees.

get

/fscmRestApi/resources/11.13.18.05/publicSectorTransactionLatestAssignees

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:
  
  

  • FindByRecordKey: Finds the transaction assignee using the specified transaction key.
    Finder Variables:
    • lnpRecordKey; integer; The transaction key.
    • value; string.
  • PrimaryKey: Finds a transaction assignee using the specified transaction key, assignee ID, and assigned date and time.
    Finder Variables:
    • TransAssignKey; integer; The transaction assignment key.
  • simpleSearchFinder: Finds the transaction assignee using the LNP record type and assignee type.
    Finder Variables:
    • value; string; The user input value of LNP record ID and assignee type.
• 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:
  

  • Active; string; Indicates the currently active assignee for the transaction. The default value is yes.
  • AssignedDatetime; string; The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.
  • AssigneeId; integer; The unique ID of the agency staff assigned to the transaction.
  • AssigneeType; string; The role of the agency staff assigned to the transaction.
  • AssigneeUserid; string; The description of the role of the agency staff assigned to the transaction.
  • CreatedBy; string; The currently active assignee for the transaction.
  • CreationDate; string; The user who created the assessment details.
  • LastUpdateDate; string; The date when the assessment details were created.
  • LastUpdatedBy; string; The user who last updated the assessment details.
  • LnpRecordId; string; Identifies the license and permit record, for example a license number with a value such as RA-2017-00029.
  • LnpRecordKey; integer; Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
  • ParentPuid; string; The public unique identifier of a migrated record.
  • TransAssignKey; integer; Indicates the transaction key for the assignment record.
  • TransAssignPuid; string; The public unique identifier of a migrated transaction assignment record.
• 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 : publicSectorTransactionLatestAssignees

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

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

Type: object

Show Source

• Active: string
  Title: Active

  Read Only: true

  Maximum Length: 1

  Indicates the currently active assignee for the transaction. The default value is yes.
• AssignedDatetime: string (date-time)
  Title: Assigned Date and Time

  Read Only: true

  The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.
• AssigneeId: integer (int64)
  Title: Assignee ID

  Read Only: true

  The unique ID of the agency staff assigned to the transaction.
• AssigneeType: string
  Title: Assignee Type

  Read Only: true

  Maximum Length: 20

  The role of the agency staff assigned to the transaction.
• AssigneeUserid: string
  Title: Assignee User ID

  Read Only: true

  Maximum Length: 64

  The description of the role of the agency staff assigned to the transaction.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The currently active assignee for the transaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The user who created the assessment details.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the assessment details were created.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the assessment details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Record ID

  Read Only: true

  Maximum Length: 50

  Identifies the license and permit record, for example a license number with a value such as RA-2017-00029.
• LnpRecordKey: integer (int64)
  Title: Transaction Key

  Read Only: true

  Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• ParentPuid: string
  Read Only: true

  Maximum Length: 64

  The public unique identifier of a migrated record.
• TransAssignKey: integer (int64)
  Read Only: true

  Indicates the transaction key for the assignment record.
• TransAssignPuid: string
  Read Only: true

  Maximum Length: 480

  The public unique identifier of a migrated transaction assignment record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the assessment details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"Identifies the license and permit record, for example a license number with a value such as RA-2017-00029.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The user who created the assessment details.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeUserid":{
            "title":"Assignee User ID",
            "maxLength":"64",
            "type":"string",
            "description":"The description of the role of the agency staff assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The currently active assignee for the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "title":"Transaction Key",
            "type":"integer",
            "description":"Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentPuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of a migrated record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Active":{
            "title":"Active",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the currently active assignee for the transaction. The default value is yes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeId":{
            "title":"Assignee ID",
            "type":"integer",
            "description":"The unique ID of the agency staff assigned to the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssigneeType":{
            "title":"Assignee Type",
            "maxLength":"20",
            "type":"string",
            "description":"The role of the agency staff assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransAssignKey":{
            "type":"integer",
            "description":"Indicates the transaction key for the assignment record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedDatetime":{
            "title":"Assigned Date and Time",
            "type":"string",
            "description":"The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransAssignPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of a migrated transaction assignment record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "format":"date-time",
            "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