POST api/WIClient/SearchInmates

Request Information

URI Parameters

None.

Body Parameters

WIClientAPI_SearchRequest
NameDescriptionTypeAdditional information
aInmate

AInmate

None.

authUser

AuthUser

None.

Request Formats

application/json, text/json

Sample:
{
  "aInmate": {
    "jsInmateNumber": "sample string 1",
    "InmateFirstName": "sample string 2",
    "InmateLastName": "sample string 3"
  },
  "authUser": {
    "userid": "sample string 1",
    "password": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<WIClientAPI_SearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CNCWrapperBased.WIClientAPI">
  <authUser xmlns:d2p1="http://schemas.datacontract.org/2004/07/CNCWrapperBased">
    <d2p1:password>sample string 2</d2p1:password>
    <d2p1:userid>sample string 1</d2p1:userid>
  </authUser>
  <aInmate>
    <InmateFirstName>sample string 2</InmateFirstName>
    <InmateLastName>sample string 3</InmateLastName>
    <jsInmateNumber>sample string 1</jsInmateNumber>
  </aInmate>
</WIClientAPI_SearchRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WIClientAPI_SearchRequest'.

Response Information

Resource Description

WIClientAPI_SearchResponse
NameDescriptionTypeAdditional information
aInmates

Collection of AInmate

None.

sErrorMsg

string

None.

bHasError

boolean

None.

nErrorCode

integer

None.

totalMillisecs

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "aInmates": [
    {
      "jsInmateNumber": "sample string 1",
      "InmateFirstName": "sample string 2",
      "InmateLastName": "sample string 3"
    },
    {
      "jsInmateNumber": "sample string 1",
      "InmateFirstName": "sample string 2",
      "InmateLastName": "sample string 3"
    }
  ],
  "sErrorMsg": "sample string 1",
  "bHasError": true,
  "nErrorCode": 3,
  "totalMillisecs": 4
}

application/xml, text/xml

Sample:
<WIClientAPI_SearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CNCWrapperBased.WIClientAPI">
  <bHasError>true</bHasError>
  <nErrorCode>3</nErrorCode>
  <sErrorMsg>sample string 1</sErrorMsg>
  <totalMillisecs>4</totalMillisecs>
  <aInmates>
    <AInmate>
      <InmateFirstName>sample string 2</InmateFirstName>
      <InmateLastName>sample string 3</InmateLastName>
      <jsInmateNumber>sample string 1</jsInmateNumber>
    </AInmate>
    <AInmate>
      <InmateFirstName>sample string 2</InmateFirstName>
      <InmateLastName>sample string 3</InmateLastName>
      <jsInmateNumber>sample string 1</jsInmateNumber>
    </AInmate>
  </aInmates>
</WIClientAPI_SearchResponse>