| Requires any of the roles: | Client, Admin, Partner |
| POST | /channel_sms_messages |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Namespace Global
Namespace digitaluapi.ServiceModel
<DataContract>
Public Partial Class ChannelSmsMessagesAdd
<DataMember(Order:=2)>
<Validate(Validator:="NotNull")>
Public Overridable Property StatusCodesId As Long
<DataMember(Order:=3)>
Public Overridable Property Reference As String
<DataMember(Order:=4)>
<Validate(Validator:="NotNull")>
Public Overridable Property TenantsId As Integer
<DataMember(Order:=5)>
<Validate(Validator:="NotNull")>
Public Overridable Property ChannelMessagesId As Long
<DataMember(Order:=6)>
<Validate(Validator:="NotNull")>
Public Overridable Property Recipients As String
<DataMember(Order:=7)>
<Validate(Validator:="NotNull")>
Public Overridable Property TemplatesId As Integer
<DataMember(Order:=8)>
<Validate(Validator:="NotNull")>
Public Overridable Property TemplateText As String
<DataMember(Order:=9)>
<Validate(Validator:="NotNull")>
Public Overridable Property DateCreated As DateTimeOffset
<DataMember(Order:=10)>
Public Overridable Property DateSent As DateTimeOffset?
<DataMember(Order:=11)>
<Validate(Validator:="NotNull")>
Public Overridable Property RetryCount As Integer
<DataMember(Order:=12)>
<Validate(Validator:="NotNull")>
Public Overridable Property MessageGuid As Guid
End Class
Public Partial Class ChannelSmsMessagesAddResponse
<DataMember(Order:=2)>
Public Overridable Property StatusCodesId As Long
<DataMember(Order:=3)>
Public Overridable Property Reference As String
<DataMember(Order:=4)>
Public Overridable Property TenantsId As Integer
<DataMember(Order:=5)>
Public Overridable Property ChannelMessagesId As Long
<DataMember(Order:=6)>
Public Overridable Property Recipients As String
<DataMember(Order:=7)>
Public Overridable Property TemplatesId As Integer
<DataMember(Order:=8)>
Public Overridable Property TemplateText As String
<DataMember(Order:=9)>
Public Overridable Property DateCreated As DateTimeOffset
<DataMember(Order:=10)>
Public Overridable Property DateSent As DateTimeOffset?
<DataMember(Order:=11)>
Public Overridable Property RetryCount As Integer
<DataMember(Order:=12)>
Public Overridable Property MessageGuid As Guid
<DataMember(Order:=14)>
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET ChannelSmsMessagesAdd DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /channel_sms_messages HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ChannelSmsMessagesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<StatusCodesId>0</StatusCodesId>
<Reference>String</Reference>
<TenantsId>0</TenantsId>
<ChannelMessagesId>0</ChannelMessagesId>
<Recipients>String</Recipients>
<TemplatesId>0</TemplatesId>
<TemplateText>String</TemplateText>
<DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</DateCreated>
<DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</DateSent>
<RetryCount>0</RetryCount>
<MessageGuid>00000000-0000-0000-0000-000000000000</MessageGuid>
</ChannelSmsMessagesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ChannelSmsMessagesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<ChannelMessagesId>0</ChannelMessagesId>
<DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</DateCreated>
<DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</DateSent>
<MessageGuid>00000000-0000-0000-0000-000000000000</MessageGuid>
<Recipients>String</Recipients>
<Reference>String</Reference>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<RetryCount>0</RetryCount>
<StatusCodesId>0</StatusCodesId>
<TemplateText>String</TemplateText>
<TemplatesId>0</TemplatesId>
<TenantsId>0</TenantsId>
</ChannelSmsMessagesAddResponse>