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

<back to all web services

VersionAdd

Add/update a program version record. Version records should be sent at application startup and then no more often than once every 24 hours. Version records are valid for 30 days.

The following routes are available for this service:
POST,GET/version/add
VersionAdd Parameters:
NameParameterData TypeRequiredDescription
CallsignbodystringYesSysop callsign (no SSID)
ProgrambodystringYesName of program (e.g., Winlink Express)
VersionbodystringYesDotted version of the program (e.g., 1.2.3)
CommentsbodystringNo
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 /version/add HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Callsign: String,
	Program: String,
	Version: String,
	Comments: 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
		}
	}
}