Antel Merchandiser App API

CheckPrincipals

The following routes are available for this service:
POST	/principal/check

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.AppApi.Models
Imports WebService.AppApi.Models.Base

Namespace Global

    Namespace WebService.AppApi.Models

        Public Partial Class AuthRuleData
            Public Overridable Property FromValue As Double
            Public Overridable Property ToValue As Double
            Public Overridable Property Allow As Boolean
            Public Overridable Property AuthRequired As Boolean
            Public Overridable Property Region As String
            Public Overridable Property Channel As String
            Public Overridable Property UnitOfMeasure As UnitOfMeasureData
        End Class

        Public Partial Class CheckPrincipals
            Inherits ApiServiceRequest
            Public Sub New()
                Principals = New List(Of PrincipalAppSync)
            End Sub

            Public Overridable Property Principals As List(Of PrincipalAppSync)
        End Class

        Public Partial Class CheckPrincipalsResponse
            Inherits ApiServiceResponse
            Public Sub New()
                PrincipalsToUpdate = New List(Of Integer)
                PrincipalAppSyncData = New List(Of PrincipalAppSync)
                AuthRules = New List(Of PrincipalAuthRuleData)
            End Sub

            Public Overridable Property PrincipalsToUpdate As List(Of Integer)
            Public Overridable Property PrincipalAppSyncData As List(Of PrincipalAppSync)
            Public Overridable Property AuthRules As List(Of PrincipalAuthRuleData)
        End Class

        Public Partial Class PrincipalAppSync
            Public Overridable Property PrincipalId As Integer
            Public Overridable Property LastUpdated As String
        End Class

        Public Partial Class PrincipalAuthRuleData
            Public Sub New()
                ValueAuthRules = New List(Of AuthRuleData)
                UnitAuthRules = New List(Of AuthRuleData)
            End Sub

            Public Overridable Property PrincipalId As Integer
            Public Overridable Property ValueAuthRules As List(Of AuthRuleData)
            Public Overridable Property UnitAuthRules As List(Of AuthRuleData)
        End Class

        Public Partial Class UnitOfMeasureData
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
        End Class
    End Namespace

    Namespace WebService.AppApi.Models.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            Implements IHasDeviceInfo
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String

            '''<Summary>
            '''Latitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Latitude of the user making this request")>
            Public Overridable Property Latitude As Double

            '''<Summary>
            '''Longitude of the user making this request
            '''</Summary>
            <ApiMember(DataType:="double", Description:="Longitude of the user making this request")>
            Public Overridable Property Longitude As Double
        End Class

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            '''<Summary>
            '''Information about the response.
            '''</Summary>
            <ApiMember(Description:="Information about the response.", IsRequired:=true)>
            Public Overridable Property Description As String

            '''<Summary>
            '''Heading or summary of the response.
            '''</Summary>
            <ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
            Public Overridable Property Heading As String

            '''<Summary>
            '''Did the intended operation for this response complete successfully?
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="Did the intended operation for this response complete successfully?", IsRequired:=true)>
            Public Overridable Property WasSuccessful As Boolean

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET CheckPrincipals DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /principal/check HTTP/1.1 
Host: returnit-api-dev.happen.zone 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Principals":[{"PrincipalId":0,"LastUpdated":"String"}],"ApiKey":"String","Latitude":0,"Longitude":0}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PrincipalsToUpdate":[0],"PrincipalAppSyncData":[{"PrincipalId":0,"LastUpdated":"String"}],"AuthRules":[{"PrincipalId":0,"ValueAuthRules":[{}],"UnitAuthRules":[{}]}],"Description":"String","Heading":"String","WasSuccessful":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}