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

<back to all web services

CmsApplicationStatusGet

Returns a list showing the status of all applications running on the specified server.

The following routes are available for this service:
POST,GET/cms/applicationStatus/get
POST,GET/cms/applicationStatus
CmsApplicationStatusGet Parameters:
NameParameterData TypeRequiredDescription
CmsNamebodystringYesThe CMS name (e.g., 'Perth')
WebServiceRequest Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYesWeb service access key -- allows use of Winlink web services
CmsApplicationStatusGetResponse Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
CmsNameformstringNo
OnlineformboolNo
ApplicationsformList<CmsApplication>No
WebServiceResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CmsApplication Parameters:
NameParameterData TypeRequiredDescription
TimestampformDateTimeNo
NameformstringNo
RunningformboolNo
VersionformstringNo

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

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

{
	Timestamp: 0001-01-01,
	CmsName: String,
	Online: False,
	Applications: 
	[
		{
			Timestamp: 0001-01-01,
			Name: String,
			Running: False,
			Version: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}