| All Verbs | /api/listitems/{ListItemId} |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPIModel.Models
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.Models
Public Partial Class ListItemModel
Public Overridable Property ListItemId As Guid
Public Overridable Property Name As String
Public Overridable Property Description As String
Public Overridable Property ShortName As String
Public Overridable Property IsDefault As Boolean
Public Overridable Property Order As Integer
Public Overridable Property ListItemTrafficLightId As Guid
Public Overridable Property PrimaryListItemImageId As Guid
Public Overridable Property PrimaryListItemImageUrl As String
Public Overridable Property PrimaryImageThumbnailUrl As String
Public Overridable Property OwnerContactId As Guid
Public Overridable Property RecordStatus As String
End Class
End Namespace
Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
'''<Summary>
'''Get details of the specified list item
'''</Summary>
<Api(Description:="Get details of the specified list item")>
Public Partial Class GetListItem
'''<Summary>
'''List item id to retrieve details for
'''</Summary>
<ApiMember(DataType:="Guid", Description:="List item id to retrieve details for", IsRequired:=true, Name:="ListItemId", ParameterType:="query")>
Public Overridable Property ListItemId As Guid
End Class
<ApiResponse(Description:="List item details")>
Public Partial Class GetListItemResponse
Public Overridable Property ListItem As ListItemModel
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/listitems/{ListItemId} HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ListItem:
{
Name: String,
Description: String,
ShortName: String,
IsDefault: False,
Order: 0,
PrimaryListItemImageUrl: String,
PrimaryImageThumbnailUrl: String,
RecordStatus: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}