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

<back to all web services

SessionRecordAdd

Adds a gateway session record to the database.

The following routes are available for this service:
POST,GET/status/session/add
POST,GET/session/add
SessionRecordAdd Parameters:
NameParameterData TypeRequiredDescription
ApplicationbodystringNo
VersionbodystringNo
CmsbodystringNo
ServerbodystringNo
ClientbodystringNo
SidbodystringNo
ModebodystringNo
FrequencybodyintNo
KilometersbodyintNo
DegreesbodyintNo
LastCommandbodystringNo
MessagesSentbodyintNo
MessagesReceivedbodyintNo
BytesSentbodyintNo
BytesReceivedbodyintNo
HoldingSecondsbodyintNo
IdTagbodystringNo
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 /jsv/reply/SessionRecordAdd HTTP/1.1 
Host: cms.winlink.org 
Content-Type: text/jsv
Content-Length: length

{
	Application: String,
	Version: String,
	Cms: String,
	Server: String,
	Client: String,
	Sid: String,
	Mode: String,
	Frequency: 0,
	Kilometers: 0,
	Degrees: 0,
	LastCommand: String,
	MessagesSent: 0,
	MessagesReceived: 0,
	BytesSent: 0,
	BytesReceived: 0,
	HoldingSeconds: 0,
	IdTag: 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
		}
	}
}