Create an ad hoc text
post
/fscmRestApi/resources/11.13.18.05/publicSectorAdhocTexts
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)
Default Value:
1
The unique identifier of the agency associated with the ad hoc text. -
ApplicationAddress1: string
Title:
Application Address 1
Maximum Length:240
The Application Address Line 1 for Business Entity Location. -
ApplicationAddress2: string
Title:
Application Address 2
Maximum Length:240
The Application Address Line 2 for Business Entity Location. -
ApplicationAddress3: string
Title:
Application Address 3
Maximum Length:240
The Application Address Line 3 for Business Entity Location. -
ApplicationAddress4: string
Title:
Application Address 4
Maximum Length:240
The Application Address Line 4 for Business Entity Location. -
ApplicationCity: string
Title:
Application City
Maximum Length:60
The Application City Name for Business Entity Location. -
ApplicationCountry: string
Title:
Application Country
Maximum Length:3
The Application Country Name for Business Entity Location. -
ApplicationCounty: string
Title:
Application County
Maximum Length:20
The Application County Name for Business Entity Location. -
ApplicationDbaBusinessName: string
Title:
Doing Business As
Maximum Length:360
Doing Business As name for Business Entity Location. -
ApplicationOrganizationName: string
Title:
Organization Name
Maximum Length:360
Organization Name for Business Entity Location. -
ApplicationPostal: string
Title:
Application Postal Code
Maximum Length:60
Postal code for Business Entity Location. -
ApplicationState: string
Title:
Application State
Maximum Length:60
State name for Business Entity Location. -
Body: string
The body of the ad hoc text.
-
EventId: integer
(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress: string
The sender phone number of the ad hoc text.
-
Log: string
(byte)
The communication ad hoc text request error details.
-
LogId: integer
(int64)
Title:
Log ID
The unique identifier for the communication ad hoc text. This ID is automatically generated by the application. -
PayloadData: string
The data payload provided with the ad hoc text request.
-
PreferredLanguage: string
The language used for the text message.
-
RecordFifthKeyId: string
Title:
Record Fifth Key ID
Maximum Length:100
The fifth key id name of the communication resource associated with the event. -
RecordFifthKeyName: string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue: string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyId: string
Title:
Record First Key ID
Maximum Length:100
The first key id name of the communication resource associated with the event. -
RecordFirstKeyName: string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue: string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyId: string
Title:
Record Fourth Key ID
Maximum Length:100
The fourth key id name of the communication resource associated with the event. -
RecordFourthKeyName: string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue: string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier: string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyId: string
Title:
Record Second Key ID
Maximum Length:100
The second key id name of the communication resource associated with the event. -
RecordSecondKeyName: string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue: string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier: string
Title:
Record Subidentifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyId: string
Title:
Record Third Key ID
Maximum Length:100
The third key id name of the communication resource associated with the event. -
RecordThirdKeyName: string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue: string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ResourceEndPoint: string
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc text.
-
SourceDescription: string
Title:
Event Name
Maximum Length:500
The event name for which the communication is triggered. -
Status: string
Title:
Status
Maximum Length:30
The status of the ad hoc text request. -
ToAddress: string
The phone numbers of the ad hoc text recipients.
-
Visibility: string
The visibility option of the triggered ad hoc text.
-
WebFormData: string
The web form details attached to the text.
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.
Root Schema : publicSectorAdhocTexts-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the ad hoc text. -
ApplicationAddress1: string
Title:
Application Address 1
Maximum Length:240
The Application Address Line 1 for Business Entity Location. -
ApplicationAddress2: string
Title:
Application Address 2
Maximum Length:240
The Application Address Line 2 for Business Entity Location. -
ApplicationAddress3: string
Title:
Application Address 3
Maximum Length:240
The Application Address Line 3 for Business Entity Location. -
ApplicationAddress4: string
Title:
Application Address 4
Maximum Length:240
The Application Address Line 4 for Business Entity Location. -
ApplicationCity: string
Title:
Application City
Maximum Length:60
The Application City Name for Business Entity Location. -
ApplicationCountry: string
Title:
Application Country
Maximum Length:3
The Application Country Name for Business Entity Location. -
ApplicationCounty: string
Title:
Application County
Maximum Length:20
The Application County Name for Business Entity Location. -
ApplicationDbaBusinessName: string
Title:
Doing Business As
Maximum Length:360
Doing Business As name for Business Entity Location. -
ApplicationOrganizationName: string
Title:
Organization Name
Maximum Length:360
Organization Name for Business Entity Location. -
ApplicationPostal: string
Title:
Application Postal Code
Maximum Length:60
Postal code for Business Entity Location. -
ApplicationState: string
Title:
Application State
Maximum Length:60
State name for Business Entity Location. -
Body: string
The body of the ad hoc text.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the ad hoc text request. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the ad hoc text request was created. -
EventId: integer
(int64)
Title:
Event ID
The unique identifier for the communication event. -
FromAddress: string
The sender phone number of the ad hoc text.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date that the ad hoc text request was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the communication ad hoc email request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Log: string
(byte)
The communication ad hoc text request error details.
-
LogId: integer
(int64)
Title:
Log ID
The unique identifier for the communication ad hoc text. This ID is automatically generated by the application. -
PayloadData: string
The data payload provided with the ad hoc text request.
-
PreferredLanguage: string
The language used for the text message.
-
RecordFifthKeyId: string
Title:
Record Fifth Key ID
Maximum Length:100
The fifth key id name of the communication resource associated with the event. -
RecordFifthKeyName: string
Title:
Record Fifth Key Name
Maximum Length:32
The fifth key name of the communication resource associated with the event. -
RecordFifthKeyValue: string
Title:
Record Fifth Key Value
Maximum Length:100
The fifth key value of the communication resource associated with the event. -
RecordFirstKeyId: string
Title:
Record First Key ID
Maximum Length:100
The first key id name of the communication resource associated with the event. -
RecordFirstKeyName: string
Title:
Record First Key Name
Maximum Length:32
The first key name of the communication resource associated with the event. -
RecordFirstKeyValue: string
Title:
Record First Key Value
Maximum Length:100
The first key value of the communication resource associated with the event. -
RecordFourthKeyId: string
Title:
Record Fourth Key ID
Maximum Length:100
The fourth key id name of the communication resource associated with the event. -
RecordFourthKeyName: string
Title:
Record Fourth Key Name
Maximum Length:32
The fourth key name of the communication resource associated with the event. -
RecordFourthKeyValue: string
Title:
Record Fourth Key Value
Maximum Length:100
The fourth key value of the communication resource associated with the event. -
RecordIdentifier: string
Title:
Record Identifier
Maximum Length:100
The communication request identifier passed through the communication request. -
RecordSecondKeyId: string
Title:
Record Second Key ID
Maximum Length:100
The second key id name of the communication resource associated with the event. -
RecordSecondKeyName: string
Title:
Record Second Key Name
Maximum Length:32
The second key name of the communication resource associated with the event. -
RecordSecondKeyValue: string
Title:
Record Second Key Value
Maximum Length:100
The second key value of the communication resource associated with the event. -
RecordSubIdentifier: string
Title:
Record Subidentifier
Maximum Length:100
The communication request sub identifier passed through the communication request. -
RecordThirdKeyId: string
Title:
Record Third Key ID
Maximum Length:100
The third key id name of the communication resource associated with the event. -
RecordThirdKeyName: string
Title:
Record Third Key Name
Maximum Length:32
The third key name of the communication resource associated with the event. -
RecordThirdKeyValue: string
Title:
Record Third Key Value
Maximum Length:100
The third key value of the communication resource associated with the event. -
ResourceEndPoint: string
The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc text.
-
SourceDescription: string
Title:
Event Name
Maximum Length:500
The event name for which the communication is triggered. -
Status: string
Title:
Status
Maximum Length:30
The status of the ad hoc text request. -
ToAddress: string
The phone numbers of the ad hoc text recipients.
-
Visibility: string
The visibility option of the triggered ad hoc text.
-
WebFormData: string
The web form details attached to the text.
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.