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

<back to all web services

MessagePickupStationAdd

Adds an entry to the MPS table. If the combination of callsign and mpsCallsign already exist only the timestamp is updated.

The following routes are available for this service:
POST,GET/mps/add
MessagePickupStationAdd Parameters:
NameParameterData TypeRequiredDescription
RequesterbodystringYesCallsign of requestor
CallsignbodystringYesStation callsign
PasswordbodystringYesAccount password
MpsCallsignbodystringYesMPS callsign
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 /mps/add HTTP/1.1 
Host: perth.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Requester: String,
	Callsign: String,
	Password: String,
	MpsCallsign: 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
		}
	}
}