OnAIRTools.Api

<back to all web services

GetMessages

Requires Authentication
The following routes are available for this service:
GET/station/{StationId}/messages
GET/messages
GetMessages Parameters:
NameParameterData TypeRequiredDescription
StationIdpathintNo
GetMessagesResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<Message>No
Message Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
StationIdformintNo
FromNameformstringNo
FromNumberformstringNo
MessageDateformDateTime?No
MessageTextformstringNo

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.

GET /station/{StationId}/messages HTTP/1.1 
Host: onairtools.nl 
Accept: text/jsv
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
		}
	},
	Result: 
	[
		{
			Id: 0,
			StationId: 0,
			FromName: String,
			FromNumber: String,
			MessageDate: 0001-01-01,
			MessageText: String
		}
	]
}