NetCard Server Web API

<back to all web services

GetInmateDetailsByUserId

The following routes are available for this service:
GET/PrisonKiosk/Inmates/UserId/{UserId}

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

HTTP + JSV

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

POST /jsv/reply/GetInmateDetailsByUserId HTTP/1.1 
Host: ncapi.net.au 
Content-Type: text/jsv
Content-Length: length

{
	UserId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	Inmate: 
	{
		InmateId: 0,
		UserId: 0,
		IJIS: String,
		Block: String,
		FirstName: String,
		LastName: String,
		Facility: String,
		ReceivedDateTime: 0001-01-01,
		IsReadyForDischarge: False,
		IsDischarged: False,
		DischargeAmount: 0,
		PTS: 0,
		LayBy: 0,
		DischargeDate: 0001-01-01,
		ReleaseStatus: String,
		Restrictions: String,
		WeeklySpendLimit: 0,
		SecurityStatus: String,
		ReleaseDate: 0001-01-01,
		CommitedOrdersAmount: 0,
		WTDSpend: 0,
		CashWithdrawalAmount: 0,
		AccountStatus: String,
		SpendingAccountBalance: 0,
		SavingsAccountBalance: 0,
		ExpectedDischargeDateUtc: 0001-01-01,
		DischargedFromFacility: String,
		IsDischargeMoneyCollected: False,
		NextMoveOutFromFacilityDateUtc: 0001-01-01,
		IsReadyForNextMoveOutFromFacility: False,
		IsNewInmate: False,
		AvailableDeposit: 0
	},
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String
		}
	]
}