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

<back to all web services

GroupAddressList

Returns the complete list of group address records or a filtered set if GroupCallsign is set.

The following routes are available for this service:
POST,GET/groupAddress/list
GroupAddressList Parameters:
NameParameterData TypeRequiredDescription
GroupCallsignbodystringNoCallsign of the group
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
GroupAddressListResponse Parameters:
NameParameterData TypeRequiredDescription
AddressListformList<GroupAddressRecord>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
GroupAddressRecord Parameters:
NameParameterData TypeRequiredDescription
GroupCallsignformstringNo
AddressformstringNo
SubjectContainsformstringNo
EnteredByformstringNo

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

{
	GroupCallsign: String,
	Key: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	AddressList: 
	[
		{
			GroupCallsign: String,
			Address: String,
			SubjectContains: String,
			EnteredBy: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}