Tigris Social Api

<back to all web services

UnreadPosts

The following routes are available for this service:
GET/Users/UnreadPostsRetrieves unread posts for user.
Parameters:
NameParameterData TypeRequiredDescription
ParticipantIdquerystringNoThe Id field is a GUID uniquely identifying the Tigris participant.
ExternalUsernamequerystringNoThe ExternalUsername field is a string uniquely identifying the Tigris participant by External Username.
OffsetquerystringNoThe starting row to return. Default: 0
LimitquerystringNoThe number of rows to return. Default 10
ReturnquerystringNoFilter to Posts that indicate the return type of the get (FULL, SUMMARY or COUNTONLY). Defaults to FULL. FULL returns all Post properties; SUMMARY returns all Post properties except Content and AuthorType.

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/UnreadPosts HTTP/1.1 
Host: api.tigris.mymitchell.com 
Content-Type: text/jsv
Content-Length: length

{
	ParticipantId: 00000000000000000000000000000000,
	ExternalUsername: String,
	Offset: 0,
	Limit: 0,
	Return: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Count: 0,
	StreamPosts: 
	[
		{
			Id: 00000000000000000000000000000000,
			PostSource: Standard,
			SubscriptionId: 00000000000000000000000000000000,
			AuthorType: String,
			Content: String,
			MessageType: 0,
			ExpirationDate: 0001-01-01,
			CreatedTime: 0001-01-01,
			UpdatedTime: 0001-01-01,
			ContentCreatedTime: 0001-01-01,
			ContentUpdatedTime: 0001-01-01
		}
	]
}