digitaluapi

SendGrandcomSmsRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/communication/message/grandcom/sms	Sends an SMS to phone numbers provided.

import 'package:servicestack/servicestack.dart';

class GrandcomMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    GrandcomMessage({this.channel,this.to,this.content,this.clientMessageId});
    GrandcomMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "GrandcomMessage";
    TypeContext? context = _ctx;
}

class GrandcomResponseMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    bool? hasError;
    GrandcomMessage? msg;

    GrandcomResponseMsg({this.apiMessageId,this.accepted,this.to,this.error,this.hasError,this.msg});
    GrandcomResponseMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        hasError = json['hasError'];
        msg = JsonConverters.fromJson(json['msg'],'GrandcomMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'hasError': hasError,
        'msg': JsonConverters.toJson(msg,'GrandcomMessage',context!)
    };

    getTypeName() => "GrandcomResponseMsg";
    TypeContext? context = _ctx;
}

class GrandcomMsgResponse implements IConvertible
{
    List<GrandcomResponseMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    GrandcomMsgResponse({this.messages,this.error,this.ResponseStatus});
    GrandcomMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<GrandcomResponseMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<GrandcomResponseMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GrandcomMsgResponse";
    TypeContext? context = _ctx;
}

class SendGrandcomSmsRequest implements IConvertible
{
    /**
    * Messages to be Sent
    */
    // @ApiMember(Description="Messages to be Sent", IsRequired=true)
    List<GrandcomMessage>? Messages = [];

    SendGrandcomSmsRequest({this.Messages});
    SendGrandcomSmsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Messages = JsonConverters.fromJson(json['Messages'],'List<GrandcomMessage>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Messages': JsonConverters.toJson(Messages,'List<GrandcomMessage>',context!)
    };

    getTypeName() => "SendGrandcomSmsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'GrandcomMessage': TypeInfo(TypeOf.Class, create:() => GrandcomMessage()),
    'GrandcomResponseMsg': TypeInfo(TypeOf.Class, create:() => GrandcomResponseMsg()),
    'GrandcomMsgResponse': TypeInfo(TypeOf.Class, create:() => GrandcomMsgResponse()),
    'List<GrandcomResponseMsg>': TypeInfo(TypeOf.Class, create:() => <GrandcomResponseMsg>[]),
    'SendGrandcomSmsRequest': TypeInfo(TypeOf.Class, create:() => SendGrandcomSmsRequest()),
    'List<GrandcomMessage>': TypeInfo(TypeOf.Class, create:() => <GrandcomMessage>[]),
});

Dart SendGrandcomSmsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /communication/message/grandcom/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Messages: 
	[
		{
			channel: String,
			to: String,
			content: String,
			clientMessageId: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	messages: 
	[
		{
			apiMessageId: String,
			accepted: False,
			to: String,
			error: String,
			hasError: False,
			msg: 
			{
				channel: String,
				to: String,
				content: String,
				clientMessageId: String
			}
		}
	],
	error: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}