Create a set of BL workflow communication items
post
/fscmRestApi/resources/11.13.18.05/publicSectorBlWorkflowCommunications
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
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 : publicSectorBlWorkflowCommunications-item-response
Type:
Show Source
object
-
AboutToExpireDate: string
(date-time)
Title:
About to Expire Date
Read Only:true
The date when the notification about an expiring license or permit is sent. -
Address1: string
Title:
Applicant Address Line 1
Read Only:true
Maximum Length:240
The first line of the business license applicant address. -
Address2: string
Title:
Applicant Address Line 2
Read Only:true
Maximum Length:240
The second line of the business license applicant address. -
AddressId: integer
(int64)
Title:
Location Address ID
Read Only:true
The reference key to the TCA location table. -
AgencyId: integer
(int32)
Read Only:
true
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
AppAcceptDate: string
(date-time)
Title:
Acceptance Date
Read Only:true
Identifies the accepted date for the business license application. -
ApplAteDate: string
(date-time)
Title:
Application About to Expire Date
Read Only:true
Identifies the date on which an about-to-expire notification is sent for the permit application. -
ApplExpirationDate: string
(date-time)
Title:
Application Expiration Date
Read Only:true
The date the application expires. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the permit applicant. -
ApplicantBizProfileId: integer
(int64)
Read Only:
true
The business profile used by the applicant. -
ApplicantPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The area code in the phone number of the business license applicant. -
ApplicantPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The country code in the phone number of the business license applicant. -
ApplicantPhoneExtension: string
Title:
Applicant Phone Extension
Read Only:true
Maximum Length:20
The phone number extension for the business license applicant. -
ApplicantPhoneNumber: string
Title:
Applicant Phone Number
Read Only:true
Maximum Length:61
The license applicant phone number. -
ApplicantProfileId: integer
(int64)
Read Only:
true
The user profile of the applicant. -
ApplicantUserId: string
Title:
Applicant User ID
Read Only:true
Maximum Length:255
The user ID of the business license applicant. -
AssignedSpecialistEmail: string
Title:
Assigned Specialist Email
Read Only:true
Maximum Length:255
The email of the specialist who is assigned to the application. -
AssignedSpecialistName: string
Title:
Assigned Specialist Name
Read Only:true
Maximum Length:255
The user name of the specialist who is assigned to the application. -
AssignedSpecialistUserid: string
Title:
Assigned Specialist User ID
Read Only:true
Maximum Length:64
The user ID of the specialist who is assigned to the application. -
AssignedSpecialistWorkPhone: string
Title:
Assigned Specialist Work Phone
Read Only:true
Maximum Length:255
The work phone contact of the specialist who is assigned to the application. -
AttributeCategory: string
Read Only:
true
Maximum Length:30
The category of the business license type. -
BalanceDue: number
Title:
Fees Balance Due
Read Only:true
The total fees balance due for the license application. -
BusAddress1: string
Title:
Business Address 1
Read Only:true
Maximum Length:240
The address portion of the business??? address. -
BusAddress2: string
Title:
Business Address 2
Read Only:true
Maximum Length:240
The address portion of the business??? address. -
BusBusinessLegalName: string
Title:
Business Legal Name
Read Only:true
Maximum Length:240
The legal name of the business entity. -
BusBusinessName: string
Title:
Business
Read Only:true
Maximum Length:100
The name of the applicant's business. For example, a contractor enters his or her contracting business name. -
BusCity: string
Title:
Business City
Read Only:true
Maximum Length:60
The city portion of the business??? address. -
BusCountry: string
Title:
Business Country
Read Only:true
Maximum Length:3
The address portion of the business??? address. -
BusCounty: string
Title:
Business County
Read Only:true
Maximum Length:60
The county portion of the business??? address. -
BusDbaBusinessName: string
Title:
Doing Business As
Read Only:true
Maximum Length:100
The doing business as name for the business. -
BusDescription: string
Title:
Location Business Description
Read Only:true
Maximum Length:200
A field in the business information component of the form designer used to enter a description of the business. -
BusOwnershipType: string
Title:
Business Ownership Type
Read Only:true
Maximum Length:15
A field in the business information component of the form designer used to describe the type of business ownership. -
BusPostalCode: string
Title:
Business Postal Code
Read Only:true
Maximum Length:60
The postal code portion of the business??? address. -
BusProvince: string
Title:
Business Province
Read Only:true
Maximum Length:60
The province portion of the business??? address. -
BusState: string
Title:
Business State
Read Only:true
Maximum Length:60
The state portion of the business??? address. -
CancelledByName: string
Title:
Canceled by Name
Read Only:true
Maximum Length:255
Identifies the user name of the person who canceled the license application. -
Cancelledcreatedby: string
Title:
Canceled by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who canceled the business license application. -
Cancelledcreationdate: string
(date-time)
Title:
Cancellation Date
Read Only:true
Identifies the cancelation date of the business license application. -
Cancelledreason: string
Title:
Cancellation Reason
Read Only:true
Maximum Length:1000
Identifies the reason for the cancelation of the business license application. -
City: string
Title:
Applicant City
Read Only:true
Maximum Length:60
The city in the business license applicant address. -
Classification: string
Read Only:
true
Maximum Length:3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
ClassificationMeaning: string
Title:
Classification
Read Only:true
Maximum Length:80
Identifies the classification of the business license application type. -
Country: string
Title:
Applicant Country
Read Only:true
Maximum Length:3
The country in the permit applicant address. -
County: string
Title:
Applicant County
Read Only:true
Maximum Length:60
The county in the permit applicant address. -
CreatedBy: string
Title:
Created by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who created the business license application. -
CreatedByName: string
Title:
Created by Name
Read Only:true
Maximum Length:255
Identifies the user name of the person who created the license application. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Identifies the date on which the business license application was created. -
CurrencyCode: string
Title:
Currency
Read Only:true
Maximum Length:3
Identifies the currency code. -
DelinquentDate: string
(date-time)
Read Only:
true
The date the license becomes delinquent. -
Description: string
Title:
Activity Description
Read Only:true
Maximum Length:100
The description for business license application. -
EmailAddress1: string
Title:
Applicant Email 1
Read Only:true
Maximum Length:320
The first email address of the business license applicant. -
EmailAddress2: string
Title:
Applicant Email 2
Read Only:true
Maximum Length:320
The second email address of the business license applicant. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Read Only:true
The date the license or permit is no longer valid. -
ExpirationGraceDate: string
(date-time)
Title:
Grace Period Date
Read Only:true
Identifies the expiration grace date for the business license application. -
ExpirationStatus: string
Title:
Expiration Status Code
Read Only:true
Maximum Length:15
Identifies the expiration status of the business license application. -
ExpirationStatusDescription: string
Title:
Expiration Status
Read Only:true
Maximum Length:80
The description for the expiration status. -
FeeDueUpdateDate: string
(date-time)
Title:
Fees Due Updated Date
Read Only:true
The identifier that captures the date when fee item with due status is added or updated. -
IssueDate: string
(date-time)
Title:
Issue Date
Read Only:true
The date the license or permit was issued. Used in the application information component of the Permit Designer. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Identifies the last updated date of the business license application. -
LastUpdatedBy: string
Title:
Last Updated by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who last updated the business license application. -
LastUpdatedByName: string
Title:
Last Updated by Name
Read Only:true
Maximum Length:255
Identifies the user name of the person who last updated the license application. -
LicensePeriod: string
Title:
License Period
Read Only:true
Maximum Length:100
The duration in which the business license is valid. -
LicenseStatus: string
Title:
License Status
Read Only:true
Maximum Length:30
The overall status for the business license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Title:
License ID
Read Only:true
Maximum Length:50
The identifier for the business license record. -
LnpRecordKey: integer
Read Only:
true
The unique identifier for the record. -
LocAltPhoneExtn: string
Title:
Location Alternate Phone Extension
Read Only:true
Maximum Length:20
The additional extension number after initial connection to an internal telephone system. -
LocAltPhoneNumber: string
Title:
Location Alternate Phone Number
Read Only:true
Maximum Length:61
The location???s full phone number. -
LocAltPhoneType: string
Title:
Location Alternate Phone Type
Read Only:true
Maximum Length:30
The type of phone for the location. -
LocationAddressOne: string
Title:
Location Address Line 1
Read Only:true
Maximum Length:240
Address Line 1 as part of the parcel address. -
LocationAddressTwo: string
Title:
Location Address Line 2
Read Only:true
Maximum Length:240
Address Line 2 as part of the parcel address. -
LocationCity: string
Title:
Location City
Read Only:true
Maximum Length:60
The city that is part of the parcel address. -
LocationCountry: string
Title:
Location Country
Read Only:true
Maximum Length:3
The country that is part of the parcel address. -
LocationCounty: string
Title:
Location County
Read Only:true
Maximum Length:60
The county in which the parcel address is located. -
LocationPostalCode: string
Title:
Location Postal Code
Read Only:true
Maximum Length:60
The postal code that is part of the parcel address. -
LocationProvince: string
Title:
Location Province
Read Only:true
Maximum Length:60
The location information about the province in which the parcel address is located. -
LocationState: string
Title:
Location State
Read Only:true
Maximum Length:60
The state that is part of the parcel address. -
LocationType: string
Title:
Location Type
Read Only:true
Maximum Length:30
The location type for the license application. -
LocEmailAddress: string
Title:
Location Primary Email
Read Only:true
Maximum Length:320
The business location???s email address. -
LocPrimaryPhoneExtn: string
Title:
Location Primary Phone Extension
Read Only:true
Maximum Length:20
The additional extension number after initial connection to an internal telephone system. -
LocPrimaryPhoneNumber: string
Title:
Location Primary Phone
Read Only:true
Maximum Length:61
The phone number of the location. -
LocPrimaryPhoneType: string
Title:
Location Primary Phone Type
Read Only:true
Maximum Length:30
The type of phone for the location. -
MailingAddress1: string
Title:
Mailing Address Line 1
Read Only:true
Maximum Length:240
The address portion of the location???s address. -
MailingAddress2: string
Title:
Mailing Address Line 2
Read Only:true
Maximum Length:240
The address portion of the location???s address. -
MailingCity: string
Title:
Mailing Address City
Read Only:true
Maximum Length:60
The city portion of the location???s address. -
MailingCountry: string
Title:
Mailing Address Country
Read Only:true
Maximum Length:3
The country portion of the location???s address. -
MailingCounty: string
Title:
Mailing Address County
Read Only:true
Maximum Length:60
The county portion of the location???s address. -
MailingPostalCode: string
Title:
Mailing Address Postal Code
Read Only:true
Maximum Length:60
The postal code portion of the location???s address. -
MailingProvince: string
Title:
Mailing Address Province
Read Only:true
Maximum Length:60
The province portion of the location???s address. -
MailingState: string
Title:
Mailing Address State
Read Only:true
Maximum Length:60
The state portion of the location???s address. -
MobileBusFlag: string
Title:
Mobile Business
Read Only:true
Maximum Length:1
Indicates that the business is a mobile business. -
NaicsCodes: string
Title:
NAICS Code
Read Only:true
Maximum Length:4000
Indicates comma separated list of NAICS codes. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The system attribute that notes the incremental version number for an object. -
OrganizationName: string
Title:
Applicant Business Name
Read Only:true
Maximum Length:360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
Originator: string
Title:
Originator
Read Only:true
Maximum Length:3
Identifies the originator of the business license application. -
ParcelId: integer
(int64)
Title:
Location Parcel ID
Read Only:true
The identifier of the record parcel. -
PersonFirstName: string
Title:
Applicant First Name
Read Only:true
Maximum Length:150
The applicant first name. -
PersonLastName: string
Title:
Applicant Last Name
Read Only:true
Maximum Length:150
The applicant last name. -
PersonMiddleName: string
Title:
Applicant Middle Name
Read Only:true
Maximum Length:60
The applicant middle name. -
PersonName: string
Title:
Applicant Full Name
Read Only:true
Maximum Length:450
The license or business license applicant name. -
PersonTitle: string
Title:
Applicant Title
Read Only:true
Maximum Length:60
The title of the contact. -
PostalCode: string
Title:
Applicant Postal Code
Read Only:true
Maximum Length:60
The postal code in the permit applicant address. -
Province: string
Title:
Applicant Province
Read Only:true
Maximum Length:60
The province in the business license applicant address. -
ReceivedDate: string
(date-time)
Title:
Received Date
Read Only:true
Identifies the received date for the license application. -
RecordStatus: string
Read Only:
true
Maximum Length:15
The status of the record. -
RecordType: string
Title:
License Type
Read Only:true
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The identifier for a record type. -
RenewalDate: string
(date-time)
Title:
Renewal Date
Read Only:true
The renewal date for the license or permit. -
State: string
Title:
Applicant State
Read Only:true
Maximum Length:60
The state in the permit applicant address. -
Status: string
Read Only:
true
Maximum Length:15
The status of the business license application. -
StatusDescription: string
Title:
Activity Status
Read Only:true
Maximum Length:100
The status description of the business. -
Subclassification: string
Read Only:
true
Maximum Length:10
The subclassification code of the business license application type. -
SubclassificationMeaning: string
Title:
Subclassification
Read Only:true
Maximum Length:80
Identifies the subclassification of the business license application type. -
SubmitDate: string
(date-time)
Title:
Submission Date
Read Only:true
The date the license transaction was submitted. -
SubmittedBy: string
Title:
Submitted by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who submitted the business license application. -
SubmittedByName: string
Title:
Submitted by Name
Read Only:true
Maximum Length:255
Identifies the user name of the person who submitted the license application. -
SystemStatus: string
Title:
Activity System Status Code
Read Only:true
Maximum Length:15
Identifies the system status of the business license application. -
SystemStatusDescription: string
Title:
Activity System Status
Read Only:true
Maximum Length:80
The system status description of the business license application. -
TotalFees: integer
(int64)
Title:
Fees Total Amount
Read Only:true
The total fees for the license application. -
TotalHold: number
Title:
Fees on Hold
Read Only:true
Identifies the total hold fee amount. -
TotalOutstanding: number
Title:
Fees Outstanding Balance
Read Only:true
Identifies the total outstanding fee amount. -
TotalPaid: integer
(int64)
Title:
Fees Total Paid
Read Only:true
The total fees paid for the license application. -
TotalPayable: number
Title:
Fees Total Payable
Read Only:true
The total fees paid for the license application. -
TotalPending: number
Title:
Fees in Pending Status
Read Only:true
Identifies the total pending fee amount. -
TotalWaived: number
Title:
Fees Waived
Read Only:true
Identifies the total fee waived. -
Url: string
Title:
URL
Read Only:true
Maximum Length:255
The URL for the license application. -
UrlLabel: string
Title:
Link to Business License Activity
Read Only:true
Maximum Length:255
The URL label for the license application. -
VersionType: string
Title:
Version Type
Read Only:true
Maximum Length:1
The version of the business license application. -
WfProcessId: number
Read Only:
true
The unique identifier for a workflow process. -
WithdrawnByName: string
Title:
Withdrawn by Name
Read Only:true
Maximum Length:255
Identifies the user name of the person who withdrew the license application. -
Withdrawncreatedby: string
Title:
Withdrawn by User ID
Read Only:true
Maximum Length:64
Identifies the user ID of the person who withdrew the business license application. -
Withdrawncreateddate: string
(date-time)
Title:
Withdrawal Date
Read Only:true
Identifies the withdrawal date of the business license application. -
Withdrawnreason: string
Title:
Withdrawal Reason
Read Only:true
Maximum Length:1000
Identifies the reason for the withdrawal of the business license application.
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.