s1 API Host

<back to all web services

GetUrgentMessageRequest

The following routes are available for this service:
GET, OPTIONS/api/urgentmessages/{id}Get an urgent message.User has to be authenticated and needs to be an admin.
Parameters:
NameParameterData TypeRequiredDescription
IdpathintYesThe id of the urgent message.

To override the Content-type in your clients 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/GetUrgentMessageRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	urgentMessage: 
	{
		id: 0,
		startDate: 0001-01-01,
		endDate: 0001-01-01,
		level: Info,
		title: String,
		message: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}