Create a set of all license inactivation or reactivation request records
post
/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests
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
-
AgencyId: integer
(int32)
This attribute indicates agency id.
-
BusinessEntityId: string
Maximum Length:
50
The business entity ID for the inactivated entity object. -
BusinessEntityKey: integer
(int64)
The business entity key for the inactivated entity object.
-
BusinessLocationId: string
Maximum Length:
50
The business location ID for the inactivated location object. -
BusinessLocationKey: integer
(int64)
The business location key for the inactivated location object.
-
CompletedOn: string
(date-time)
Title:
Inactivated On
This attribute indicates the date the change was completed. -
EffChangeDate: string
(date)
Title:
Effective Inactivation Date
This attribute indicates the effective date of the license inactivation. -
InactivateReason: string
Title:
Reason for Inactivation
Maximum Length:30
This attribute indicates the reason for the inactivation. -
LnpRecordId: string
Maximum Length:
50
The meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the related transaction.
-
ReactivateReason: string
Maximum Length:
30
The reason for the inactivation. -
RecordNumber: string
Maximum Length:
64
The parent transaction PUID that is also used by CRM import. -
RequestCode: string
Maximum Length:
30
The type of change requested. -
RequestDetails: string
Title:
Additional Details
Maximum Length:1000
The details of the requests. -
RequestKey: integer
(int64)
This attribute indicates the unique identifier for the request.
-
RequestorEmail: string
Title:
Requester Email
Maximum Length:320
The email of the person requesting the change. -
RequestorName: string
Title:
Requester Name
Maximum Length:450
The name of the person requesting the change. -
RequestorPhone: string
Title:
Requester Phone
Maximum Length:40
The phone of the person requesting the change. -
RequestorStaffFlag: string
Title:
Requester is agency staff
Maximum Length:1
Indicates that the staff initiated the request. -
RequestorTitle: string
Title:
Requester Title
Maximum Length:60
The title of the person requesting the change. -
RequestPuid: string
Maximum Length:
480
The alternate key for the CRM import. -
RequestStatus: string
Maximum Length:
30
The status of the request. -
StatusHistoryPuid: string
Maximum Length:
480
The alternate key for CRM import. -
TransactionType: string
Maximum Length:
10
The transaction type related to the request.
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 : publicSectorRecordActivationRequests-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
This attribute indicates agency id.
-
BusinessEntityId: string
Maximum Length:
50
The business entity ID for the inactivated entity object. -
BusinessEntityKey: integer
(int64)
The business entity key for the inactivated entity object.
-
BusinessLocationId: string
Maximum Length:
50
The business location ID for the inactivated location object. -
BusinessLocationKey: integer
(int64)
The business location key for the inactivated location object.
-
CompletedByName: string
Title:
Inactivated By
Read Only:true
Maximum Length:255
The name of agency staff that processed the change. -
CompletedOn: string
(date-time)
Title:
Inactivated On
This attribute indicates the date the change was completed. -
CreationDate: string
(date-time)
Read Only:
true
This attribute indicates the date and time of the creation of the row. -
EffChangeDate: string
(date)
Title:
Effective Inactivation Date
This attribute indicates the effective date of the license inactivation. -
InactivateReason: string
Title:
Reason for Inactivation
Maximum Length:30
This attribute indicates the reason for the inactivation. -
LastUpdateDate: string
(date-time)
Read Only:
true
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Maximum Length:
50
The meaningful identifier for the transaction. -
LnpRecordKey: integer
(int64)
The unique identifier for the related transaction.
-
ReactivateReason: string
Maximum Length:
30
The reason for the inactivation. -
RecordNumber: string
Maximum Length:
64
The parent transaction PUID that is also used by CRM import. -
RequestCode: string
Maximum Length:
30
The type of change requested. -
RequestDetails: string
Title:
Additional Details
Maximum Length:1000
The details of the requests. -
RequestKey: integer
(int64)
This attribute indicates the unique identifier for the request.
-
RequestorEmail: string
Title:
Requester Email
Maximum Length:320
The email of the person requesting the change. -
RequestorName: string
Title:
Requester Name
Maximum Length:450
The name of the person requesting the change. -
RequestorPhone: string
Title:
Requester Phone
Maximum Length:40
The phone of the person requesting the change. -
RequestorStaffFlag: string
Title:
Requester is agency staff
Maximum Length:1
Indicates that the staff initiated the request. -
RequestorTitle: string
Title:
Requester Title
Maximum Length:60
The title of the person requesting the change. -
RequestPuid: string
Maximum Length:
480
The alternate key for the CRM import. -
RequestStatus: string
Maximum Length:
30
The status of the request. -
StatusHistoryPuid: string
Maximum Length:
480
The alternate key for CRM import. -
TransactionType: string
Maximum Length:
10
The transaction type related to the request.
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.