NetCard Server Web API

<back to all web services

PGPreCheck

The following routes are available for this service:
POST/PrisonKiosk/PGPreCheck/

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

HTTP + XML

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

POST /xml/reply/PGPreCheck HTTP/1.1 
Host: ncapi.net.au 
Content-Type: application/xml
Content-Length: length

<PGPreCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.PayShoppingCart">
  <ShoppingCart xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:AvailableFunds>0</d2p1:AvailableFunds>
    <d2p1:CartItems>
      <d2p1:PG_ShoppingCartItemDTO>
        <d2p1:CartItemId>0</d2p1:CartItemId>
        <d2p1:InventoryId>0</d2p1:InventoryId>
        <d2p1:MaxQuantity>0</d2p1:MaxQuantity>
        <d2p1:Product>
          <d2p1:Cost>0</d2p1:Cost>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:HealthFlagId>0</d2p1:HealthFlagId>
          <d2p1:Healthy>false</d2p1:Healthy>
          <d2p1:IsAdvertise>false</d2p1:IsAdvertise>
          <d2p1:ManufacturerId>0</d2p1:ManufacturerId>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Note>String</d2p1:Note>
          <d2p1:PaidTax>0</d2p1:PaidTax>
          <d2p1:PicCode>String</d2p1:PicCode>
          <d2p1:ProductId>0</d2p1:ProductId>
          <d2p1:ProductImage>String</d2p1:ProductImage>
          <d2p1:RecommendedSalePrice>0</d2p1:RecommendedSalePrice>
          <d2p1:ShortDescription>String</d2p1:ShortDescription>
          <d2p1:Size>String</d2p1:Size>
          <d2p1:StockCode>String</d2p1:StockCode>
          <d2p1:StockRestriction>String</d2p1:StockRestriction>
          <d2p1:SupplierId>0</d2p1:SupplierId>
          <d2p1:UnitCost>0</d2p1:UnitCost>
        </d2p1:Product>
        <d2p1:Quantity>0</d2p1:Quantity>
        <d2p1:TotalCartItemLinePrice>0</d2p1:TotalCartItemLinePrice>
      </d2p1:PG_ShoppingCartItemDTO>
    </d2p1:CartItems>
    <d2p1:CashDispensePay>
      <d2p1:CashDispenseId>0</d2p1:CashDispenseId>
      <d2p1:CashDispenseTypeId>0</d2p1:CashDispenseTypeId>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:DeviceId>0</d2p1:DeviceId>
      <d2p1:TotalCash>0</d2p1:TotalCash>
    </d2p1:CashDispensePay>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:TotalPurchase>0</d2p1:TotalPurchase>
    <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
    <d2p1:UserId>0</d2p1:UserId>
  </ShoppingCart>
</PGPreCheck>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PGPreCheckResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.PayShoppingCart">
  <ErrorCode xmlns="http://schemas.servicestack.net/types">String</ErrorCode>
  <Message xmlns="http://schemas.servicestack.net/types">String</Message>
  <StackTrace xmlns="http://schemas.servicestack.net/types">String</StackTrace>
  <Errors xmlns="http://schemas.servicestack.net/types">
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
    </ResponseError>
  </Errors>
  <IsValid>false</IsValid>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <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:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</PGPreCheckResponse>