Create a transaction assignee
post
/fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Active: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates the currently active assignee for the transaction. The default value is yes. -
AssignedDatetime: string
(date-time)
Title:
Assigned Date and Time
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
The unique ID of the agency staff assigned to the transaction. -
AssigneeType: string
Title:
Assignee Type
Maximum Length:20
The role of the agency staff assigned to the transaction. -
AssigneeUserid: string
Title:
Assignee User ID
Maximum Length:64
The unique user ID of the agency staff assigned to the transaction. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The license and permit record, for example a license number with a value such as RA-2017-00029. -
LnpRecordKey: integer
(int64)
Title:
Transaction Key
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. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The user who last updated the assessment details. -
ParentPuid: string
Maximum Length:
64
The public unique identifier of a migrated record. -
TransAssignKey: integer
(int64)
Indicates the transaction key for the assignment record.
-
TransAssignPuid: string
Maximum Length:
480
The public unique identifier of a migrated transaction assignment record.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorTransactionAssignees-item-response
Type:
Show Source
object
-
Active: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates the currently active assignee for the transaction. The default value is yes. -
AssignedDatetime: string
(date-time)
Title:
Assigned Date and Time
The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments. -
AssigneeEmail: string
Read Only:
true
The official email ID of the planner or specialist assigned to the transaction. -
AssigneeId: integer
(int64)
Title:
Assignee ID
The unique ID of the agency staff assigned to the transaction. -
AssigneeJob: string
Read Only:
true
The job of the agency staff assigned to the transaction. -
AssigneeName: string
Read Only:
true
Maximum Length:240
The name of the agency staff assigned to the transaction. -
AssigneeType: string
Title:
Assignee Type
Maximum Length:20
The role of the agency staff assigned to the transaction. -
AssigneeUserid: string
Title:
Assignee User ID
Maximum Length:64
The unique user ID of the agency staff assigned to the transaction. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the assessment details were created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the assessment details were last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
Record ID
Maximum Length:50
The license and permit record, for example a license number with a value such as RA-2017-00029. -
LnpRecordKey: integer
(int64)
Title:
Transaction Key
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. -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The description of the role of the agency staff assigned to the transaction. -
NextAssignee: string
Read Only:
true
The assignee to whom the transaction was assigned next. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The user who last updated the assessment details. -
ParentPuid: string
Maximum Length:
64
The public unique identifier of a migrated record. -
TransAssignKey: integer
(int64)
Indicates the transaction key for the assignment record.
-
TransAssignPuid: string
Maximum Length:
480
The public unique identifier of a migrated transaction assignment record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.