NetCard Server Web API

LoginPrisonKiosk

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/LoginPrisonKiosk HTTP/1.1 
Host: ncapi.net.au 
Content-Type: application/xml
Content-Length: length

<LoginPrisonKiosk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Authentication">
  <Password>String</Password>
  <UsernameOrEmail>String</UsernameOrEmail>
</LoginPrisonKiosk>

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

<LoginPrisonKioskResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Authentication">
  <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>
  <UserDTO xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <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>
  </UserDTO>
</LoginPrisonKioskResponse>