Antel API

<back to all web services

GetPrincipal

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetPrincipal : ApiServiceRequest()
{
    var principalId:Int? = null
}

open class ApiServiceRequest : IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /**
    * The API Key required for authentication
    */
    @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    var apiKey:String? = null

    /**
    * Latitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Latitude of the user making this request")
    var latitude:Double? = null

    /**
    * Longitude of the user making this request
    */
    @ApiMember(DataType="double", Description="Longitude of the user making this request")
    var longitude:Double? = null
}

open class GetPrincipalResponse : ApiServiceResponse()
{
    @SerializedName("data") var Data:PrincipalData? = null
}

open class ApiServiceResponse : IServiceResponse
{
    /**
    * Information about the response.
    */
    @ApiMember(Description="Information about the response.", IsRequired=true)
    var description:String? = null

    /**
    * Heading or summary of the response.
    */
    @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    var heading:String? = null

    /**
    * Did the intended operation for this response complete successfully?
    */
    @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    var wasSuccessful:Boolean? = null

    var responseStatus:ResponseStatus? = null
}

open class PrincipalData
{
    var principalId:Int? = null
    var name:String? = null
    var authLetterFileUrl:ArrayList<String> = ArrayList<String>()
    var logoImageUrl:String? = null
    var products:ArrayList<ProductDataCategory> = ArrayList<ProductDataCategory>()
    var upliftPrefix:String? = null
    var contactName:String? = null
    var contactNumber:String? = null
    var contactEmail:String? = null
    var allowProductLookup:Boolean? = null
    var hasLogo:Boolean? = null
    var hasAuthLetter:Boolean? = null
    var sealNetWeightMandatory:Boolean? = null
    var allowBillableSeals:Boolean? = null
    var captureSerialNumber:Boolean? = null
    var batchCodesMandatory:Boolean? = null
    var captureManufactureAndExpiryDate:Boolean? = null
    var productExceptions:ArrayList<ProductExceptionData> = ArrayList<ProductExceptionData>()
    var usesOwnSealNumbers:Boolean? = null
}

open class ProductDataCategory
{
    var unitBarcode:String? = null
    var products:ArrayList<ProductData> = ArrayList<ProductData>()
}

open class ProductData
{
    var productId:Int? = null
    var principalId:Int? = null
    var name:String? = null
    var category:String? = null
    var productCode:String? = null
    var unitBarcode:String? = null
    var cartonQuantity:Int? = null
    var shrinkQuantity:Int? = null
    var unitQuantity:Int? = null
    var cartonMeasurement:String? = null
    var shrinkMeasurement:String? = null
    var unitMeasurement:String? = null
    var cartonWeight:Double? = null
    var shrinkWeight:Double? = null
    var unitWeight:BigDecimal? = null
    var cartonPrice:BigDecimal? = null
    var shrinkPrice:BigDecimal? = null
    var unitPrice:BigDecimal? = null
    var maxQuantity:Int? = null
    var maxPrice:Int? = null
}

open class ProductExceptionData
{
    var region:String? = null
    var channel:String? = null
    var productId:Int? = null
    var stockStatusIds:ArrayList<Int> = ArrayList<Int>()
}

Kotlin GetPrincipal DTOs

GET /principal/get HTTP/1.1 
Host: antel.api.dev.86degrees.com 
Accept: text/jsonl

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

{"data":{"principalId":0,"name":"String","authLetterFileUrl":["String"],"logoImageUrl":"String","products":[{"unitBarcode":"String","products":[{"productId":0,"principalId":0,"name":"String","category":"String","productCode":"String","unitBarcode":"String","cartonQuantity":0,"shrinkQuantity":0,"unitQuantity":0,"cartonMeasurement":"String","shrinkMeasurement":"String","unitMeasurement":"String","cartonWeight":0,"shrinkWeight":0,"unitWeight":0,"cartonPrice":0,"shrinkPrice":0,"unitPrice":0,"maxQuantity":0,"maxPrice":0}]}],"upliftPrefix":"String","contactName":"String","contactNumber":"String","contactEmail":"String","allowProductLookup":false,"hasLogo":false,"hasAuthLetter":false,"sealNetWeightMandatory":false,"allowBillableSeals":false,"captureSerialNumber":false,"batchCodesMandatory":false,"captureManufactureAndExpiryDate":false,"productExceptions":[{"region":"String","channel":"String","productId":0,"stockStatusIds":[0]}],"usesOwnSealNumbers":false},"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"}}}