HTTP + JSV
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /jsv/reply/CreateRequestComplaint HTTP/1.1
Host: ncapi.net.au
Content-Type: text/jsv
Content-Length: length
{
UserId: 0,
DeviceId: 0,
InmateRequestComplaint:
{
InmateRequestComplaintId: 0,
InmateRequestId: 0,
Subject: String,
Description: String,
To: String,
AnswerUserId: 0,
AnswerDescription: String,
InmateRequest:
{
InmateRequestId: 0,
Date: 0001-01-01,
UserId: 0,
Status: String,
RequestType: String,
DeviceId: 0,
ApprovedBy: 0,
ApprovedDate: 0001-01-01,
UserFullName: String,
User:
{
UserId: 0,
Username: String,
Password: String,
IsActive: False,
LastUpdated: 0001-01-01,
Title: String,
FirstName: String,
LastName: String,
FullName: String String,
UserGenderId: 0,
Phone: String,
Email: String,
MailAddress: String,
MemberId: String,
CustomerId: 0,
UserAccessTypeId: 0,
DateOfBirth: 0001-01-01,
Mobile: String,
StreetNumber: String,
City: String,
State: String,
LocationId: 0,
ChildLocationId: 0,
LastLogin: 0001-01-01,
UserAccount:
{
UserId: 0,
UserAccountTypeId: 0,
AccountCode: String,
AccountPin: String,
AmountAvailable: 0,
LastUpdated: 0001-01-01,
IsActive: False,
RewardPoints: 0,
LunchMoney: 0,
ActivationDate: 0001-01-01,
Note: String,
Block: String,
User:
{
UserId: 0,
Username: String,
Password: String,
IsActive: False,
LastUpdated: 0001-01-01,
Title: String,
FirstName: String,
LastName: String,
FullName: String String,
UserGenderId: 0,
Phone: String,
Email: String,
MailAddress: String,
MemberId: String,
CustomerId: 0,
UserAccessTypeId: 0,
DateOfBirth: 0001-01-01,
Mobile: String,
StreetNumber: String,
City: String,
State: String,
LocationId: 0,
ChildLocationId: 0,
LastLogin: 0001-01-01,
UserAccount:
{
UserId: 0,
UserAccountTypeId: 0,
AccountCode: String,
AccountPin: String,
AmountAvailable: 0,
LastUpdated: 0001-01-01,
IsActive: False,
RewardPoints: 0,
LunchMoney: 0,
ActivationDate: 0001-01-01,
Note: String,
Block: String,
User:
{
UserId: 0,
Username: String,
Password: String,
IsActive: False,
LastUpdated: 0001-01-01,
Title: String,
FirstName: String,
LastName: String,
FullName: String String,
UserGenderId: 0,
Phone: String,
Email: String,
MailAddress: String,
MemberId: String,
CustomerId: 0,
UserAccessTypeId: 0,
DateOfBirth: 0001-01-01,
Mobile: String,
StreetNumber: String,
City: String,
State: String,
LocationId: 0,
ChildLocationId: 0,
LastLogin: 0001-01-01,
UserAccount:
{
UserId: 0,
UserAccountTypeId: 0,
AccountCode: String,
AccountPin: String,
AmountAvailable: 0,
LastUpdated: 0001-01-01,
IsActive: False,
RewardPoints: 0,
LunchMoney: 0,
ActivationDate: 0001-01-01,
Note: String,
Block: String,
SpendingLimit: 0,
AmountAvailable2: 0,
DischargeAmount: 0,
LunchMoneyStatus: 0,
AmountDeposited: 0,
CollectedLunchMoneyDate: 0001-01-01,
CardNumber: String,
NumberOfShopsBuy: 0,
ProfileImagePath: String,
IncidentalInStatus: 0,
PinLockOutTimeUtc: 0001-01-01,
PalmId: String
},
Location:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
ChildLocation:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
GroupId: 0,
Group:
{
GroupId: 0,
Name: String,
Description: String,
CustomerId: 0,
AdminAccess: False
},
IsDeleted: False,
IsBanned: False,
LockTimeUtc: 0001-01-01,
IsProntoDown: False,
InmateBlock: String,
Customer:
{
CustomerId: 0,
CustomerName: String,
ApiKey: String,
Email: String,
Mobile: String,
IsActive: False,
PostCode: String,
StreetNumber: String,
City: String,
State: String,
TaxID: String,
AccessType: String
}
},
SpendingLimit: 0,
AmountAvailable2: 0,
DischargeAmount: 0,
LunchMoneyStatus: 0,
AmountDeposited: 0,
CollectedLunchMoneyDate: 0001-01-01,
CardNumber: String,
NumberOfShopsBuy: 0,
ProfileImagePath: String,
IncidentalInStatus: 0,
PinLockOutTimeUtc: 0001-01-01,
PalmId: String
},
Location:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
ChildLocation:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
GroupId: 0,
Group:
{
GroupId: 0,
Name: String,
Description: String,
CustomerId: 0,
AdminAccess: False
},
IsDeleted: False,
IsBanned: False,
LockTimeUtc: 0001-01-01,
IsProntoDown: False,
InmateBlock: String,
Customer:
{
CustomerId: 0,
CustomerName: String,
ApiKey: String,
Email: String,
Mobile: String,
IsActive: False,
PostCode: String,
StreetNumber: String,
City: String,
State: String,
TaxID: String,
AccessType: String
}
},
SpendingLimit: 0,
AmountAvailable2: 0,
DischargeAmount: 0,
LunchMoneyStatus: 0,
AmountDeposited: 0,
CollectedLunchMoneyDate: 0001-01-01,
CardNumber: String,
NumberOfShopsBuy: 0,
ProfileImagePath: String,
IncidentalInStatus: 0,
PinLockOutTimeUtc: 0001-01-01,
PalmId: String
},
Location:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
ChildLocation:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
GroupId: 0,
Group:
{
GroupId: 0,
Name: String,
Description: String,
CustomerId: 0,
AdminAccess: False
},
IsDeleted: False,
IsBanned: False,
LockTimeUtc: 0001-01-01,
IsProntoDown: False,
InmateBlock: String,
Customer:
{
CustomerId: 0,
CustomerName: String,
ApiKey: String,
Email: String,
Mobile: String,
IsActive: False,
PostCode: String,
StreetNumber: String,
City: String,
State: String,
TaxID: String,
AccessType: String
}
}
},
State: String
}
}
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
}
]
},
InmateRequests:
{
InmateRequestId: 0,
Date: 0001-01-01,
UserId: 0,
Status: String,
RequestType: String,
DeviceId: 0,
ApprovedBy: 0,
ApprovedDate: 0001-01-01,
UserFullName: String,
User:
{
UserId: 0,
Username: String,
Password: String,
IsActive: False,
LastUpdated: 0001-01-01,
Title: String,
FirstName: String,
LastName: String,
FullName: String String,
UserGenderId: 0,
Phone: String,
Email: String,
MailAddress: String,
MemberId: String,
CustomerId: 0,
UserAccessTypeId: 0,
DateOfBirth: 0001-01-01,
Mobile: String,
StreetNumber: String,
City: String,
State: String,
LocationId: 0,
ChildLocationId: 0,
LastLogin: 0001-01-01,
UserAccount:
{
UserId: 0,
UserAccountTypeId: 0,
AccountCode: String,
AccountPin: String,
AmountAvailable: 0,
LastUpdated: 0001-01-01,
IsActive: False,
RewardPoints: 0,
LunchMoney: 0,
ActivationDate: 0001-01-01,
Note: String,
Block: String,
User:
{
UserId: 0,
Username: String,
Password: String,
IsActive: False,
LastUpdated: 0001-01-01,
Title: String,
FirstName: String,
LastName: String,
FullName: String String,
UserGenderId: 0,
Phone: String,
Email: String,
MailAddress: String,
MemberId: String,
CustomerId: 0,
UserAccessTypeId: 0,
DateOfBirth: 0001-01-01,
Mobile: String,
StreetNumber: String,
City: String,
State: String,
LocationId: 0,
ChildLocationId: 0,
LastLogin: 0001-01-01,
UserAccount:
{
UserId: 0,
UserAccountTypeId: 0,
AccountCode: String,
AccountPin: String,
AmountAvailable: 0,
LastUpdated: 0001-01-01,
IsActive: False,
RewardPoints: 0,
LunchMoney: 0,
ActivationDate: 0001-01-01,
Note: String,
Block: String,
User:
{
UserId: 0,
Username: String,
Password: String,
IsActive: False,
LastUpdated: 0001-01-01,
Title: String,
FirstName: String,
LastName: String,
FullName: String String,
UserGenderId: 0,
Phone: String,
Email: String,
MailAddress: String,
MemberId: String,
CustomerId: 0,
UserAccessTypeId: 0,
DateOfBirth: 0001-01-01,
Mobile: String,
StreetNumber: String,
City: String,
State: String,
LocationId: 0,
ChildLocationId: 0,
LastLogin: 0001-01-01,
UserAccount:
{
UserId: 0,
UserAccountTypeId: 0,
AccountCode: String,
AccountPin: String,
AmountAvailable: 0,
LastUpdated: 0001-01-01,
IsActive: False,
RewardPoints: 0,
LunchMoney: 0,
ActivationDate: 0001-01-01,
Note: String,
Block: String,
SpendingLimit: 0,
AmountAvailable2: 0,
DischargeAmount: 0,
LunchMoneyStatus: 0,
AmountDeposited: 0,
CollectedLunchMoneyDate: 0001-01-01,
CardNumber: String,
NumberOfShopsBuy: 0,
ProfileImagePath: String,
IncidentalInStatus: 0,
PinLockOutTimeUtc: 0001-01-01,
PalmId: String
},
Location:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
ChildLocation:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
GroupId: 0,
Group:
{
GroupId: 0,
Name: String,
Description: String,
CustomerId: 0,
AdminAccess: False
},
IsDeleted: False,
IsBanned: False,
LockTimeUtc: 0001-01-01,
IsProntoDown: False,
InmateBlock: String,
Customer:
{
CustomerId: 0,
CustomerName: String,
ApiKey: String,
Email: String,
Mobile: String,
IsActive: False,
PostCode: String,
StreetNumber: String,
City: String,
State: String,
TaxID: String,
AccessType: String
}
},
SpendingLimit: 0,
AmountAvailable2: 0,
DischargeAmount: 0,
LunchMoneyStatus: 0,
AmountDeposited: 0,
CollectedLunchMoneyDate: 0001-01-01,
CardNumber: String,
NumberOfShopsBuy: 0,
ProfileImagePath: String,
IncidentalInStatus: 0,
PinLockOutTimeUtc: 0001-01-01,
PalmId: String
},
Location:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
ChildLocation:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
GroupId: 0,
Group:
{
GroupId: 0,
Name: String,
Description: String,
CustomerId: 0,
AdminAccess: False
},
IsDeleted: False,
IsBanned: False,
LockTimeUtc: 0001-01-01,
IsProntoDown: False,
InmateBlock: String,
Customer:
{
CustomerId: 0,
CustomerName: String,
ApiKey: String,
Email: String,
Mobile: String,
IsActive: False,
PostCode: String,
StreetNumber: String,
City: String,
State: String,
TaxID: String,
AccessType: String
}
},
SpendingLimit: 0,
AmountAvailable2: 0,
DischargeAmount: 0,
LunchMoneyStatus: 0,
AmountDeposited: 0,
CollectedLunchMoneyDate: 0001-01-01,
CardNumber: String,
NumberOfShopsBuy: 0,
ProfileImagePath: String,
IncidentalInStatus: 0,
PinLockOutTimeUtc: 0001-01-01,
PalmId: String
},
Location:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
ChildLocation:
{
LocationId: 0,
Name: String,
Description: String,
CustomerId: 0,
ParentLocationId: 0
},
GroupId: 0,
Group:
{
GroupId: 0,
Name: String,
Description: String,
CustomerId: 0,
AdminAccess: False
},
IsDeleted: False,
IsBanned: False,
LockTimeUtc: 0001-01-01,
IsProntoDown: False,
InmateBlock: String,
Customer:
{
CustomerId: 0,
CustomerName: String,
ApiKey: String,
Email: String,
Mobile: String,
IsActive: False,
PostCode: String,
StreetNumber: String,
City: String,
State: String,
TaxID: String,
AccessType: String
}
}
},
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String
}
]
}