CMS Web Services - v4.0.6459.17834 [cms-b]

<back to all web services

GroupAddressAdd

Adds or updates a group address record.

The following routes are available for this service:
POST,GET/groupAddress/add
GroupAddressAdd Parameters:
NameParameterData TypeRequiredDescription
GroupCallsignbodystringYesCallsign of the group
AddressbodystringYesCallsign or SMTP address
SubjectContainsbodystringNoText that must appear in the subject
EnteredBybodystringYesCallsign of the person entering the record
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 /groupAddress/add HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	GroupCallsign: String,
	Address: String,
	SubjectContains: String,
	EnteredBy: 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
		}
	}
}