| GET | /api/object/reference |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Saguna.Common.WebAPIModel.ServiceModels
Namespace Global
Namespace Eros.Saguna.Common.WebAPIModel.ServiceModels
'''<Summary>
'''Generate a unique reference number for the object.
'''</Summary>
<Api(Description:="Generate a unique reference number for the object.")>
Public Partial Class GenerateReferenceNumber
'''<Summary>
'''Appliance to generate object reference for.
'''</Summary>
<ApiMember(DataType:="Guid", Description:="Appliance to generate object reference for.", IsRequired:=true, Name:="ApplianceId")>
Public Overridable Property ApplianceId As Guid
End Class
<ApiResponse(Description:="Returns the generated unique reference number for the specified object")>
Public Partial Class GenerateReferenceNumberResponse
Public Overridable Property Reference As String
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET GenerateReferenceNumber DTOs
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.
GET /api/object/reference HTTP/1.1 Host: pfapi.pstpf.com.au Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Reference: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}