CMS Web Services - v4.0.6532.13712 [cms-a]

<back to all web services

MessageUserNotice

Sends a user notice message to each callsign in the specified callsign group.

The following routes are available for this service:
POST,GET/message/user/notice
MessageUserNotice Parameters:
NameParameterData TypeRequiredDescription
GroupbodyUserNoticeGroupYesGroup to receive this user notice.
UserNoticebodystringYesText of the user notice (the message body).
ActiveDaysbodyintNoEach callsign must have been active within this number of days. (Default: 21)
TestCallsignbodystringNoIf not empty causes user notice (plus selected callsign list) to be sent to this callsign account only.
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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 /message/user/notice HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Group: None,
	UserNotice: String,
	ActiveDays: 0,
	TestCallsign: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}