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

<back to all web services

CmsApplicationStatusAdd

Adds an application status record to the cmsstatus table.

The following routes are available for this service:
POST,GET/cms/applicationStatus/add
CmsApplicationStatusAdd Parameters:
NameParameterData TypeRequiredDescription
TimestampbodyDateTimeNoThe datetime value to be recorded with this application status
CmsNamebodystringYesThe CMS name (e.g., 'Perth')
ApplicationbodystringYesThe name of the applicaiton (e.g., 'CMS Telnet Server')
PropertybodystringYesThe name of the property (e.g., 'Running')
ValuebodystringNoThe value for this property (e.g., 'True')
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 /cms/applicationStatus/add HTTP/1.1 
Host: cms.winlink.org 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Timestamp: 0001-01-01,
	CmsName: String,
	Application: String,
	Property: String,
	Value: 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
		}
	}
}