NetCard Server Web API

<back to all web services

InmatePayShoppingCart

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: ncapi.net.au 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: InmatePayShoppingCart

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<InmatePayShoppingCart xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Inmate">
  <ShoppingCart xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:AvailableFunds>0</d2p1:AvailableFunds>
    <d2p1:CartItems>
      <d2p1: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:HealthFlag>
            <d2p1:Color>String</d2p1:Color>
            <d2p1:HealthFlagId>0</d2p1:HealthFlagId>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:HealthFlag>
          <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:ProductBarCodes i:nil="true" />
          <d2p1:ProductExtraOptions i:nil="true" />
          <d2p1:ProductId>0</d2p1:ProductId>
          <d2p1:ProductImage>String</d2p1:ProductImage>
          <d2p1:ProductProductCategories i:nil="true" />
          <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:ShoppingCartItemDTO>
    </d2p1:CartItems>
    <d2p1:CashDispensePay>
      <d2p1:CashDispenseId>0</d2p1:CashDispenseId>
      <d2p1:CashDispenseQuantity>
        <d2p1:CashDispenseQuantityId>0</d2p1:CashDispenseQuantityId>
        <d2p1:CoinFiftyCentQty>0</d2p1:CoinFiftyCentQty>
        <d2p1:CoinFiveCentQty>0</d2p1:CoinFiveCentQty>
        <d2p1:CoinOneQty>0</d2p1:CoinOneQty>
        <d2p1:CoinTenCentQty>0</d2p1:CoinTenCentQty>
        <d2p1:CoinTwentyCentQty>0</d2p1:CoinTwentyCentQty>
        <d2p1:CoinTwoQty>0</d2p1:CoinTwoQty>
        <d2p1:NoteFiftyQty>0</d2p1:NoteFiftyQty>
        <d2p1:NoteFiveQty>0</d2p1:NoteFiveQty>
        <d2p1:NoteOneHundredQty>0</d2p1:NoteOneHundredQty>
        <d2p1:NoteTenQty>0</d2p1:NoteTenQty>
        <d2p1:NoteTwentyQty>0</d2p1:NoteTwentyQty>
      </d2p1:CashDispenseQuantity>
      <d2p1:CashDispenseTypeId>0</d2p1:CashDispenseTypeId>
      <d2p1:CashDispenserDeviceId>0</d2p1:CashDispenserDeviceId>
      <d2p1:CashKioskGenericAccount>
        <d2p1:AccountCode>String</d2p1:AccountCode>
        <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
      </d2p1:CashKioskGenericAccount>
      <d2p1:CoinFiftyCent>0</d2p1:CoinFiftyCent>
      <d2p1:CoinFiveCent>0</d2p1:CoinFiveCent>
      <d2p1:CoinOne>0</d2p1:CoinOne>
      <d2p1:CoinTenCent>0</d2p1:CoinTenCent>
      <d2p1:CoinTwentyCent>0</d2p1:CoinTwentyCent>
      <d2p1:CoinTwo>0</d2p1:CoinTwo>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:DateIn>0001-01-01T00:00:00</d2p1:DateIn>
      <d2p1:DeviceId>0</d2p1:DeviceId>
      <d2p1:InvalidMoney>
        <d2p1:AssistingUserId>0</d2p1:AssistingUserId>
        <d2p1:BentCoinAmount>0</d2p1:BentCoinAmount>
        <d2p1:ChequeAmount>0</d2p1:ChequeAmount>
        <d2p1:InvalidMoneyId>0</d2p1:InvalidMoneyId>
        <d2p1:RippedNoteAmount>0</d2p1:RippedNoteAmount>
        <d2p1:TotalAmount>0</d2p1:TotalAmount>
        <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
      </d2p1:InvalidMoney>
      <d2p1:NoteFifty>0</d2p1:NoteFifty>
      <d2p1:NoteFive>0</d2p1:NoteFive>
      <d2p1:NoteOneHundred>0</d2p1:NoteOneHundred>
      <d2p1:NoteTen>0</d2p1:NoteTen>
      <d2p1:NoteTwenty>0</d2p1:NoteTwenty>
      <d2p1:TotalCash>0</d2p1:TotalCash>
      <d2p1:TotalCoin>0</d2p1:TotalCoin>
      <d2p1:TotalNote>0</d2p1:TotalNote>
      <d2p1:TransactionLog>
        <d2p1:AccountCode>String</d2p1:AccountCode>
        <d2p1:AmountAvailable>0</d2p1:AmountAvailable>
        <d2p1:AssistedUserId>0</d2p1:AssistedUserId>
        <d2p1:CustomerId>0</d2p1:CustomerId>
        <d2p1:DepositTransferLog>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:CreatedDateTime>0001-01-01T00:00:00</d2p1:CreatedDateTime>
          <d2p1:DepositTransferLogId>0</d2p1:DepositTransferLogId>
          <d2p1:InmateId>0</d2p1:InmateId>
          <d2p1:User>
            <d2p1:ChildLocationId>0</d2p1:ChildLocationId>
            <d2p1:City>String</d2p1:City>
            <d2p1:CustomerId>0</d2p1:CustomerId>
            <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
            <d2p1:Email>String</d2p1:Email>
            <d2p1:FirstName>String</d2p1:FirstName>
            <d2p1:GroupId>0</d2p1:GroupId>
            <d2p1:IsActive>false</d2p1:IsActive>
            <d2p1:IsProntoDown>false</d2p1:IsProntoDown>
            <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
            <d2p1:LastName>String</d2p1:LastName>
            <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
            <d2p1:Location>
              <d2p1:CustomerId>0</d2p1:CustomerId>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:LocationId>0</d2p1:LocationId>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:ParentLocationId>0</d2p1:ParentLocationId>
            </d2p1:Location>
            <d2p1:LocationId>0</d2p1:LocationId>
            <d2p1:MailAddress>String</d2p1:MailAddress>
            <d2p1:MemberId>String</d2p1:MemberId>
            <d2p1:Mobile>String</d2p1:Mobile>
            <d2p1:Password>String</d2p1:Password>
            <d2p1:Phone>String</d2p1:Phone>
            <d2p1:State>String</d2p1:State>
            <d2p1:StreetNumber>String</d2p1:StreetNumber>
            <d2p1:Title>String</d2p1:Title>
            <d2p1:UserAccessGroups i:nil="true" />
            <d2p1:UserAccessTypeId>0</d2p1:UserAccessTypeId>
            <d2p1:UserAccount>
              <d2p1:AccountCode>String</d2p1:AccountCode>
              <d2p1:AccountPin>String</d2p1:AccountPin>
              <d2p1:ActivationDate>0001-01-01T00:00:00</d2p1:ActivationDate>
              <d2p1:AmountAvailable>0</d2p1:AmountAvailable>
              <d2p1:AmountAvailable2>0</d2p1:AmountAvailable2>
              <d2p1:AmountDeposited>0</d2p1:AmountDeposited>
              <d2p1:Block>String</d2p1:Block>
              <d2p1:CardNumber>String</d2p1:CardNumber>
              <d2p1:CollectedLunchMoneyDate>0001-01-01T00:00:00</d2p1:CollectedLunchMoneyDate>
              <d2p1:DischargeAmount>0</d2p1:DischargeAmount>
              <d2p1:IncidentalInStatus>0</d2p1:IncidentalInStatus>
              <d2p1:IsActive>false</d2p1:IsActive>
              <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
              <d2p1:LunchMoney>0</d2p1:LunchMoney>
              <d2p1:LunchMoneyStatus>0</d2p1:LunchMoneyStatus>
              <d2p1:Note>String</d2p1:Note>
              <d2p1:NumberOfShopsBuy>0</d2p1:NumberOfShopsBuy>
              <d2p1:PalmId>String</d2p1:PalmId>
              <d2p1:PinLockOutTimeUtc>0001-01-01T00:00:00</d2p1:PinLockOutTimeUtc>
              <d2p1:ProfileImagePath>String</d2p1:ProfileImagePath>
              <d2p1:RewardPoints>0</d2p1:RewardPoints>
              <d2p1:SpendingLimit>0</d2p1:SpendingLimit>
              <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
              <d2p1:UserId>0</d2p1:UserId>
            </d2p1:UserAccount>
            <d2p1:UserBiometrics i:nil="true" />
            <d2p1:UserGenderId>0</d2p1:UserGenderId>
            <d2p1:UserId>0</d2p1:UserId>
            <d2p1:UserRestrictions i:nil="true" />
            <d2p1:Username>String</d2p1:Username>
          </d2p1:User>
          <d2p1:UserId>0</d2p1:UserId>
        </d2p1:DepositTransferLog>
        <d2p1:DepositTransferLogId>0</d2p1:DepositTransferLogId>
        <d2p1:DeviceId>0</d2p1:DeviceId>
        <d2p1:Options>String</d2p1:Options>
        <d2p1:OrderId>0</d2p1:OrderId>
        <d2p1:PreviousTransactionLogId>0</d2p1:PreviousTransactionLogId>
        <d2p1:ReferenceNumber>String</d2p1:ReferenceNumber>
        <d2p1:Tax>0</d2p1:Tax>
        <d2p1:TransactionAmount>0</d2p1:TransactionAmount>
        <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
        <d2p1:TransactionTime>0001-01-01T00:00:00</d2p1:TransactionTime>
        <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
        <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
      </d2p1:TransactionLog>
      <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:CashDispensePay>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:MenuProductCategories>
      <d2p1:ProductCategoryDTO>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ProductCategoryId>0</d2p1:ProductCategoryId>
      </d2p1:ProductCategoryDTO>
    </d2p1:MenuProductCategories>
    <d2p1:MenuProducts>
      <d2p1:ProductDTO>
        <d2p1:Cost>0</d2p1:Cost>
        <d2p1:CustomerId>0</d2p1:CustomerId>
        <d2p1:HealthFlag>
          <d2p1:Color>String</d2p1:Color>
          <d2p1:HealthFlagId>0</d2p1:HealthFlagId>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:HealthFlag>
        <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:ProductBarCodes i:nil="true" />
        <d2p1:ProductExtraOptions i:nil="true" />
        <d2p1:ProductId>0</d2p1:ProductId>
        <d2p1:ProductImage>String</d2p1:ProductImage>
        <d2p1:ProductProductCategories i:nil="true" />
        <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:ProductDTO>
    </d2p1:MenuProducts>
    <d2p1:MessageLogId>String</d2p1:MessageLogId>
    <d2p1:TotalPurchase>0</d2p1:TotalPurchase>
    <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
    <d2p1:UserId>0</d2p1:UserId>
  </ShoppingCart>
</InmatePayShoppingCart>

    </soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<InmatePayShoppingCartResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Inmate">
  <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>
  <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>
  <TransactionLog xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:AccountCode>String</d2p1:AccountCode>
    <d2p1:AmountAvailable>0</d2p1:AmountAvailable>
    <d2p1:AssistedUserId>0</d2p1:AssistedUserId>
    <d2p1:CustomerId>0</d2p1:CustomerId>
    <d2p1:DepositTransferLog>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:CreatedDateTime>0001-01-01T00:00:00</d2p1:CreatedDateTime>
      <d2p1:DepositTransferLogId>0</d2p1:DepositTransferLogId>
      <d2p1:InmateId>0</d2p1:InmateId>
      <d2p1:User>
        <d2p1:ChildLocationId>0</d2p1:ChildLocationId>
        <d2p1:City>String</d2p1:City>
        <d2p1:CustomerId>0</d2p1:CustomerId>
        <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
        <d2p1:Email>String</d2p1:Email>
        <d2p1:FirstName>String</d2p1:FirstName>
        <d2p1:GroupId>0</d2p1:GroupId>
        <d2p1:IsActive>false</d2p1:IsActive>
        <d2p1:IsProntoDown>false</d2p1:IsProntoDown>
        <d2p1:LastLogin>0001-01-01T00:00:00</d2p1:LastLogin>
        <d2p1:LastName>String</d2p1:LastName>
        <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
        <d2p1:Location>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:LocationId>0</d2p1:LocationId>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:ParentLocationId>0</d2p1:ParentLocationId>
        </d2p1:Location>
        <d2p1:LocationId>0</d2p1:LocationId>
        <d2p1:MailAddress>String</d2p1:MailAddress>
        <d2p1:MemberId>String</d2p1:MemberId>
        <d2p1:Mobile>String</d2p1:Mobile>
        <d2p1:Password>String</d2p1:Password>
        <d2p1:Phone>String</d2p1:Phone>
        <d2p1:State>String</d2p1:State>
        <d2p1:StreetNumber>String</d2p1:StreetNumber>
        <d2p1:Title>String</d2p1:Title>
        <d2p1:UserAccessGroups i:nil="true" />
        <d2p1:UserAccessTypeId>0</d2p1:UserAccessTypeId>
        <d2p1:UserAccount>
          <d2p1:AccountCode>String</d2p1:AccountCode>
          <d2p1:AccountPin>String</d2p1:AccountPin>
          <d2p1:ActivationDate>0001-01-01T00:00:00</d2p1:ActivationDate>
          <d2p1:AmountAvailable>0</d2p1:AmountAvailable>
          <d2p1:AmountAvailable2>0</d2p1:AmountAvailable2>
          <d2p1:AmountDeposited>0</d2p1:AmountDeposited>
          <d2p1:Block>String</d2p1:Block>
          <d2p1:CardNumber>String</d2p1:CardNumber>
          <d2p1:CollectedLunchMoneyDate>0001-01-01T00:00:00</d2p1:CollectedLunchMoneyDate>
          <d2p1:DischargeAmount>0</d2p1:DischargeAmount>
          <d2p1:IncidentalInStatus>0</d2p1:IncidentalInStatus>
          <d2p1:IsActive>false</d2p1:IsActive>
          <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
          <d2p1:LunchMoney>0</d2p1:LunchMoney>
          <d2p1:LunchMoneyStatus>0</d2p1:LunchMoneyStatus>
          <d2p1:Note>String</d2p1:Note>
          <d2p1:NumberOfShopsBuy>0</d2p1:NumberOfShopsBuy>
          <d2p1:PalmId>String</d2p1:PalmId>
          <d2p1:PinLockOutTimeUtc>0001-01-01T00:00:00</d2p1:PinLockOutTimeUtc>
          <d2p1:ProfileImagePath>String</d2p1:ProfileImagePath>
          <d2p1:RewardPoints>0</d2p1:RewardPoints>
          <d2p1:SpendingLimit>0</d2p1:SpendingLimit>
          <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
          <d2p1:UserId>0</d2p1:UserId>
        </d2p1:UserAccount>
        <d2p1:UserBiometrics i:nil="true" />
        <d2p1:UserGenderId>0</d2p1:UserGenderId>
        <d2p1:UserId>0</d2p1:UserId>
        <d2p1:UserRestrictions i:nil="true" />
        <d2p1:Username>String</d2p1:Username>
      </d2p1:User>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:DepositTransferLog>
    <d2p1:DepositTransferLogId>0</d2p1:DepositTransferLogId>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:Options>String</d2p1:Options>
    <d2p1:OrderId>0</d2p1:OrderId>
    <d2p1:PreviousTransactionLogId>0</d2p1:PreviousTransactionLogId>
    <d2p1:ReferenceNumber>String</d2p1:ReferenceNumber>
    <d2p1:Tax>0</d2p1:Tax>
    <d2p1:TransactionAmount>0</d2p1:TransactionAmount>
    <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
    <d2p1:TransactionTime>0001-01-01T00:00:00</d2p1:TransactionTime>
    <d2p1:TransactionTypeId>0</d2p1:TransactionTypeId>
    <d2p1:UserAccountTypeId>0</d2p1:UserAccountTypeId>
  </TransactionLog>
</InmatePayShoppingCartResponse>

    </soap:Body>
</soap:Envelope>