NetCard Server Web API

ReceiveInmateOrder

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

HTTP + SOAP12

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

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

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

<ReceiveInmateOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Order">
  <Order xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:DateOrdered>0001-01-01T00:00:00</d2p1:DateOrdered>
    <d2p1:DatePrinted>0001-01-01T00:00:00</d2p1:DatePrinted>
    <d2p1:Device>
      <d2p1:AssetId>String</d2p1:AssetId>
      <d2p1:Cash>0</d2p1:Cash>
      <d2p1:CashAccountCode>String</d2p1:CashAccountCode>
      <d2p1:ChildDeviceLocationId>0</d2p1:ChildDeviceLocationId>
      <d2p1:CustomerId>0</d2p1:CustomerId>
      <d2p1:DefaultTax>0</d2p1:DefaultTax>
      <d2p1:DeviceCode>String</d2p1:DeviceCode>
      <d2p1:DeviceId>0</d2p1:DeviceId>
      <d2p1:DeviceInventories i:nil="true" />
      <d2p1:DeviceLinkId>0</d2p1:DeviceLinkId>
      <d2p1:DeviceLocationId>0</d2p1:DeviceLocationId>
      <d2p1:DeviceTypeId>0</d2p1:DeviceTypeId>
      <d2p1:IsEnabled>false</d2p1:IsEnabled>
      <d2p1:LastSeen>0001-01-01T00:00:00</d2p1:LastSeen>
      <d2p1:LastVersion>String</d2p1:LastVersion>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:OpenFrom>PT0S</d2p1:OpenFrom>
      <d2p1:OpenTo>PT0S</d2p1:OpenTo>
      <d2p1:Password>String</d2p1:Password>
      <d2p1:WarehouseId>0</d2p1:WarehouseId>
    </d2p1:Device>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:IsReceived>false</d2p1:IsReceived>
    <d2p1:OrderId>0</d2p1:OrderId>
    <d2p1:OrderLine i:nil="true" />
    <d2p1:TotalAmount>0</d2p1:TotalAmount>
    <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
    <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>
  </Order>
  <OrderLines xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:OrderLineDTO>
      <d2p1:AmountPerUnit>0</d2p1:AmountPerUnit>
      <d2p1:Inventory>
        <d2p1:Barcodes xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:Barcodes>
        <d2p1:Category>String</d2p1:Category>
        <d2p1:Coil>String</d2p1:Coil>
        <d2p1:CostBuyPrice>0</d2p1:CostBuyPrice>
        <d2p1:CustomerId>0</d2p1:CustomerId>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Image>AA==</d2p1:Image>
        <d2p1:ImageVersion>0</d2p1:ImageVersion>
        <d2p1:InventoryId>0</d2p1:InventoryId>
        <d2p1:IsLow>false</d2p1:IsLow>
        <d2p1:LastChanged>0001-01-01T00:00:00</d2p1:LastChanged>
        <d2p1:Low>0</d2p1:Low>
        <d2p1:Max>0</d2p1:Max>
        <d2p1:Note>String</d2p1:Note>
        <d2p1:ParLevel>0</d2p1:ParLevel>
        <d2p1:PointsCost>0</d2p1:PointsCost>
        <d2p1:PointsRewarded>0</d2p1:PointsRewarded>
        <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:ProductCategoryId>0</d2p1:ProductCategoryId>
        <d2p1:ProductId>0</d2p1:ProductId>
        <d2p1:ProductTypeId>0</d2p1:ProductTypeId>
        <d2p1:Quantity>0</d2p1:Quantity>
        <d2p1:RawPrice>0</d2p1:RawPrice>
        <d2p1:SalePrice>0</d2p1:SalePrice>
        <d2p1:Taken>0</d2p1:Taken>
        <d2p1:Tax>0</d2p1:Tax>
        <d2p1:TaxPercent>0</d2p1:TaxPercent>
      </d2p1:Inventory>
      <d2p1:InventoryId>0</d2p1:InventoryId>
      <d2p1:Order>
        <d2p1:DateOrdered>0001-01-01T00:00:00</d2p1:DateOrdered>
        <d2p1:DatePrinted>0001-01-01T00:00:00</d2p1:DatePrinted>
        <d2p1:Device>
          <d2p1:AssetId>String</d2p1:AssetId>
          <d2p1:Cash>0</d2p1:Cash>
          <d2p1:CashAccountCode>String</d2p1:CashAccountCode>
          <d2p1:ChildDeviceLocationId>0</d2p1:ChildDeviceLocationId>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:DefaultTax>0</d2p1:DefaultTax>
          <d2p1:DeviceCode>String</d2p1:DeviceCode>
          <d2p1:DeviceId>0</d2p1:DeviceId>
          <d2p1:DeviceInventories i:nil="true" />
          <d2p1:DeviceLinkId>0</d2p1:DeviceLinkId>
          <d2p1:DeviceLocationId>0</d2p1:DeviceLocationId>
          <d2p1:DeviceTypeId>0</d2p1:DeviceTypeId>
          <d2p1:IsEnabled>false</d2p1:IsEnabled>
          <d2p1:LastSeen>0001-01-01T00:00:00</d2p1:LastSeen>
          <d2p1:LastVersion>String</d2p1:LastVersion>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Note>String</d2p1:Note>
          <d2p1:OpenFrom>PT0S</d2p1:OpenFrom>
          <d2p1:OpenTo>PT0S</d2p1:OpenTo>
          <d2p1:Password>String</d2p1:Password>
          <d2p1:WarehouseId>0</d2p1:WarehouseId>
        </d2p1:Device>
        <d2p1:DeviceId>0</d2p1:DeviceId>
        <d2p1:IsReceived>false</d2p1:IsReceived>
        <d2p1:OrderId>0</d2p1:OrderId>
        <d2p1:OrderLine i:nil="true" />
        <d2p1:TotalAmount>0</d2p1:TotalAmount>
        <d2p1:TransactionLogId>0</d2p1:TransactionLogId>
        <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:Order>
      <d2p1:OrderId>0</d2p1:OrderId>
      <d2p1:OrderLineId>0</d2p1:OrderLineId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:QuantityReceived>0</d2p1:QuantityReceived>
      <d2p1:TotalAmount>0</d2p1:TotalAmount>
    </d2p1:OrderLineDTO>
  </OrderLines>
</ReceiveInmateOrder>

    </soap12:Body>
</soap12:Envelope>

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

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

<ReceiveInmateOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Order">
  <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>
  <IsSuccess>false</IsSuccess>
  <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>
</ReceiveInmateOrderResponse>

    </soap12:Body>
</soap12:Envelope>