NetCard Server Web API

<back to all web services

GetInmateDetailsByIJIS

The following routes are available for this service:
GET/PrisonKiosk/Inmates/IJIS

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

<GetInmateDetailsByIJIS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Inmate">
  <CustomerId>0</CustomerId>
  <IJIS>String</IJIS>
</GetInmateDetailsByIJIS>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetInmateDetailsByIJISResponse 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>
  <Inmate xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:AccountStatus>String</d2p1:AccountStatus>
    <d2p1:AvailableDeposit>0</d2p1:AvailableDeposit>
    <d2p1:Block>String</d2p1:Block>
    <d2p1:CashWithdrawalAmount>0</d2p1:CashWithdrawalAmount>
    <d2p1:CommitedOrdersAmount>0</d2p1:CommitedOrdersAmount>
    <d2p1:DischargeAmount>0</d2p1:DischargeAmount>
    <d2p1:DischargeDate>0001-01-01T00:00:00</d2p1:DischargeDate>
    <d2p1:DischargedFromFacility>String</d2p1:DischargedFromFacility>
    <d2p1:ExpectedDischargeDateUtc>0001-01-01T00:00:00</d2p1:ExpectedDischargeDateUtc>
    <d2p1:Facility>String</d2p1:Facility>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:IJIS>String</d2p1:IJIS>
    <d2p1:InmateId>0</d2p1:InmateId>
    <d2p1:IsDischargeMoneyCollected>false</d2p1:IsDischargeMoneyCollected>
    <d2p1:IsDischarged>false</d2p1:IsDischarged>
    <d2p1:IsNewInmate>false</d2p1:IsNewInmate>
    <d2p1:IsReadyForDischarge>false</d2p1:IsReadyForDischarge>
    <d2p1:IsReadyForNextMoveOutFromFacility>false</d2p1:IsReadyForNextMoveOutFromFacility>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:LayBy>0</d2p1:LayBy>
    <d2p1:NextMoveOutFromFacilityDateUtc>0001-01-01T00:00:00</d2p1:NextMoveOutFromFacilityDateUtc>
    <d2p1:PTS>0</d2p1:PTS>
    <d2p1:ReceivedDateTime>0001-01-01T00:00:00</d2p1:ReceivedDateTime>
    <d2p1:ReleaseDate>0001-01-01T00:00:00</d2p1:ReleaseDate>
    <d2p1:ReleaseStatus>String</d2p1:ReleaseStatus>
    <d2p1:Restrictions>String</d2p1:Restrictions>
    <d2p1:SavingsAccountBalance>0</d2p1:SavingsAccountBalance>
    <d2p1:SecurityStatus>String</d2p1:SecurityStatus>
    <d2p1:SpendingAccountBalance>0</d2p1:SpendingAccountBalance>
    <d2p1:UserId>0</d2p1:UserId>
    <d2p1:WTDSpend>0</d2p1:WTDSpend>
    <d2p1:WeeklySpendLimit>0</d2p1:WeeklySpendLimit>
  </Inmate>
  <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>
</GetInmateDetailsByIJISResponse>