Antel API

<back to all web services

GetPrincipal

export class ApiServiceRequest implements IServiceRequest, IHasApiKey, IHasDeviceInfo
{
    /** @description The API Key required for authentication */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public apiKey: string;

    /** @description Latitude of the user making this request */
    // @ApiMember(DataType="double", Description="Latitude of the user making this request")
    public latitude: number;

    /** @description Longitude of the user making this request */
    // @ApiMember(DataType="double", Description="Longitude of the user making this request")
    public longitude: number;

    public constructor(init?: Partial<ApiServiceRequest>) { (Object as any).assign(this, init); }
}

export class ApiServiceResponse implements IServiceResponse
{
    /** @description Information about the response. */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public description: string;

    /** @description Heading or summary of the response. */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public heading: string;

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

    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<ApiServiceResponse>) { (Object as any).assign(this, init); }
}

export class ProductData
{
    public productId: number;
    public principalId: number;
    public name: string;
    public category: string;
    public productCode: string;
    public unitBarcode: string;
    public cartonQuantity: number;
    public shrinkQuantity: number;
    public unitQuantity: number;
    public cartonMeasurement: string;
    public shrinkMeasurement: string;
    public unitMeasurement: string;
    public cartonWeight: number;
    public shrinkWeight: number;
    public unitWeight: number;
    public cartonPrice: number;
    public shrinkPrice: number;
    public unitPrice: number;
    public maxQuantity: number;
    public maxPrice: number;

    public constructor(init?: Partial<ProductData>) { (Object as any).assign(this, init); }
}

export class ProductDataCategory
{
    public unitBarcode: string;
    public products: ProductData[];

    public constructor(init?: Partial<ProductDataCategory>) { (Object as any).assign(this, init); }
}

export class ProductExceptionData
{
    public region: string;
    public channel: string;
    public productId: number;
    public stockStatusIds: number[];

    public constructor(init?: Partial<ProductExceptionData>) { (Object as any).assign(this, init); }
}

export class PrincipalData
{
    public principalId: number;
    public name: string;
    public authLetterFileUrl: string[];
    public logoImageUrl: string;
    public products: ProductDataCategory[];
    public upliftPrefix: string;
    public contactName: string;
    public contactNumber: string;
    public contactEmail: string;
    public allowProductLookup: boolean;
    public hasLogo: boolean;
    public hasAuthLetter: boolean;
    public sealNetWeightMandatory: boolean;
    public allowBillableSeals: boolean;
    public captureSerialNumber: boolean;
    public batchCodesMandatory: boolean;
    public captureManufactureAndExpiryDate: boolean;
    public productExceptions: ProductExceptionData[];
    public usesOwnSealNumbers: boolean;

    public constructor(init?: Partial<PrincipalData>) { (Object as any).assign(this, init); }
}

export class GetPrincipalResponse extends ApiServiceResponse
{
    public data: PrincipalData;

    public constructor(init?: Partial<GetPrincipalResponse>) { super(init); (Object as any).assign(this, init); }
}

export class GetPrincipal extends ApiServiceRequest
{
    public principalId: number;

    public constructor(init?: Partial<GetPrincipal>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetPrincipal DTOs

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

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

<GetPrincipalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">String</Heading>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ServiceModel.Base">false</WasSuccessful>
  <Data>
    <AllowBillableSeals>false</AllowBillableSeals>
    <AllowProductLookup>false</AllowProductLookup>
    <AuthLetterFileUrl xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </AuthLetterFileUrl>
    <BatchCodesMandatory>false</BatchCodesMandatory>
    <CaptureManufactureAndExpiryDate>false</CaptureManufactureAndExpiryDate>
    <CaptureSerialNumber>false</CaptureSerialNumber>
    <ContactEmail>String</ContactEmail>
    <ContactName>String</ContactName>
    <ContactNumber>String</ContactNumber>
    <HasAuthLetter>false</HasAuthLetter>
    <HasLogo>false</HasLogo>
    <LogoImageUrl>String</LogoImageUrl>
    <Name>String</Name>
    <PrincipalId>0</PrincipalId>
    <ProductExceptions>
      <ProductExceptionData>
        <Channel>String</Channel>
        <ProductId>0</ProductId>
        <Region>String</Region>
        <StockStatusIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </StockStatusIds>
      </ProductExceptionData>
    </ProductExceptions>
    <Products>
      <ProductDataCategory>
        <Products>
          <ProductData>
            <CartonMeasurement>String</CartonMeasurement>
            <CartonPrice>0</CartonPrice>
            <CartonQuantity>0</CartonQuantity>
            <CartonWeight>0</CartonWeight>
            <Category>String</Category>
            <MaxPrice>0</MaxPrice>
            <MaxQuantity>0</MaxQuantity>
            <Name>String</Name>
            <PrincipalId>0</PrincipalId>
            <ProductCode>String</ProductCode>
            <ProductId>0</ProductId>
            <ShrinkMeasurement>String</ShrinkMeasurement>
            <ShrinkPrice>0</ShrinkPrice>
            <ShrinkQuantity>0</ShrinkQuantity>
            <ShrinkWeight>0</ShrinkWeight>
            <UnitBarcode>String</UnitBarcode>
            <UnitMeasurement>String</UnitMeasurement>
            <UnitPrice>0</UnitPrice>
            <UnitQuantity>0</UnitQuantity>
            <UnitWeight>0</UnitWeight>
          </ProductData>
        </Products>
        <UnitBarcode>String</UnitBarcode>
      </ProductDataCategory>
    </Products>
    <SealNetWeightMandatory>false</SealNetWeightMandatory>
    <UpliftPrefix>String</UpliftPrefix>
    <UsesOwnSealNumbers>false</UsesOwnSealNumbers>
  </Data>
</GetPrincipalResponse>