POST api/WI/PostCredits

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
aCredits		Collection of ACredit	None.
authUser		AuthUser	None.

Request Formats

application/json, text/json

Sample:

{
  "aCredits": [
    {
      "location": {
        "sInmateId": "sample string 1",
        "FacilityId": "sample string 2",
        "usc_facilityid": "sample string 3",
        "docNumber": "sample string 4",
        "shortDesc": "sample string 5",
        "longDesc": "sample string 6",
        "firstName": "sample string 7",
        "lastName": "sample string 8",
        "middleName": "sample string 9",
        "cellNo": "sample string 10",
        "facilityLdapId": "sample string 11",
        "IsJuvenile": false,
        "livingUnit": "sample string 12",
        "HousingUnit": "sample string 12",
        "primary_code": "sample string 13",
        "primary_desc": "sample string 14",
        "substatus_code": "sample string 15",
        "substatus_desc": "sample string 16",
        "WIWebServiceUrl": "sample string 17"
      },
      "linesItem": [
        {
          "itemDescription": "sample string 1",
          "quantityReturned": 2,
          "sellingPrice": 3.0,
          "taxRate": 4.0,
          "sExternalItem": "sample string 5",
          "unitOfMeasure": "sample string 6",
          "menuNumber": "sample string 7"
        },
        {
          "itemDescription": "sample string 1",
          "quantityReturned": 2,
          "sellingPrice": 3.0,
          "taxRate": 4.0,
          "sExternalItem": "sample string 5",
          "unitOfMeasure": "sample string 6",
          "menuNumber": "sample string 7"
        }
      ],
      "transactionId": "sample string 1",
      "OriginalSalesID": "sample string 2",
      "nonTaxableAmount": 3.0,
      "amountOfTax": 4.0,
      "taxableAmount": 5.0,
      "sInmateId": "sample string 6",
      "UTCreatedDateOfOrder": "2025-06-24T16:36:27.2978513-05:00",
      "bUseUSGCacheLocation": true,
      "sBatchId": "sample string 9",
      "sVE_TransactionId": "sample string 10",
      "txnType": "sample string 11"
    },
    {
      "location": {
        "sInmateId": "sample string 1",
        "FacilityId": "sample string 2",
        "usc_facilityid": "sample string 3",
        "docNumber": "sample string 4",
        "shortDesc": "sample string 5",
        "longDesc": "sample string 6",
        "firstName": "sample string 7",
        "lastName": "sample string 8",
        "middleName": "sample string 9",
        "cellNo": "sample string 10",
        "facilityLdapId": "sample string 11",
        "IsJuvenile": false,
        "livingUnit": "sample string 12",
        "HousingUnit": "sample string 12",
        "primary_code": "sample string 13",
        "primary_desc": "sample string 14",
        "substatus_code": "sample string 15",
        "substatus_desc": "sample string 16",
        "WIWebServiceUrl": "sample string 17"
      },
      "linesItem": [
        {
          "itemDescription": "sample string 1",
          "quantityReturned": 2,
          "sellingPrice": 3.0,
          "taxRate": 4.0,
          "sExternalItem": "sample string 5",
          "unitOfMeasure": "sample string 6",
          "menuNumber": "sample string 7"
        },
        {
          "itemDescription": "sample string 1",
          "quantityReturned": 2,
          "sellingPrice": 3.0,
          "taxRate": 4.0,
          "sExternalItem": "sample string 5",
          "unitOfMeasure": "sample string 6",
          "menuNumber": "sample string 7"
        }
      ],
      "transactionId": "sample string 1",
      "OriginalSalesID": "sample string 2",
      "nonTaxableAmount": 3.0,
      "amountOfTax": 4.0,
      "taxableAmount": 5.0,
      "sInmateId": "sample string 6",
      "UTCreatedDateOfOrder": "2025-06-24T16:36:27.2978513-05:00",
      "bUseUSGCacheLocation": true,
      "sBatchId": "sample string 9",
      "sVE_TransactionId": "sample string 10",
      "txnType": "sample string 11"
    }
  ],
  "authUser": {
    "userid": "sample string 1",
    "password": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<CreditsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CNCWrapperBased">
  <authUser>
    <password>sample string 2</password>
    <userid>sample string 1</userid>
  </authUser>
  <aCredits>
    <CreditsRequest.ACredit>
      <OriginalSalesID>sample string 2</OriginalSalesID>
      <UTCreatedDateOfOrder>2025-06-24T16:36:27.2978513-05:00</UTCreatedDateOfOrder>
      <amountOfTax>4</amountOfTax>
      <bUseUSGCacheLocation>true</bUseUSGCacheLocation>
      <linesItem>
        <CreditsRequest.ACredit.LineItemCredit>
          <itemDescription>sample string 1</itemDescription>
          <menuNumber>sample string 7</menuNumber>
          <quantityReturned>2</quantityReturned>
          <sExternalItem>sample string 5</sExternalItem>
          <sellingPrice>3</sellingPrice>
          <taxRate>4</taxRate>
          <unitOfMeasure>sample string 6</unitOfMeasure>
        </CreditsRequest.ACredit.LineItemCredit>
        <CreditsRequest.ACredit.LineItemCredit>
          <itemDescription>sample string 1</itemDescription>
          <menuNumber>sample string 7</menuNumber>
          <quantityReturned>2</quantityReturned>
          <sExternalItem>sample string 5</sExternalItem>
          <sellingPrice>3</sellingPrice>
          <taxRate>4</taxRate>
          <unitOfMeasure>sample string 6</unitOfMeasure>
        </CreditsRequest.ACredit.LineItemCredit>
      </linesItem>
      <location>
        <FacilityId>sample string 2</FacilityId>
        <WIWebServiceUrl>sample string 17</WIWebServiceUrl>
        <cellNo>sample string 10</cellNo>
        <docNumber>sample string 4</docNumber>
        <facilityLdapId>sample string 11</facilityLdapId>
        <firstName>sample string 7</firstName>
        <lastName>sample string 8</lastName>
        <livingUnit>sample string 12</livingUnit>
        <longDesc>sample string 6</longDesc>
        <middleName>sample string 9</middleName>
        <primary_code>sample string 13</primary_code>
        <primary_desc>sample string 14</primary_desc>
        <sInmateId>sample string 1</sInmateId>
        <shortDesc>sample string 5</shortDesc>
        <substatus_code>sample string 15</substatus_code>
        <substatus_desc>sample string 16</substatus_desc>
        <usc_facilityid>sample string 3</usc_facilityid>
      </location>
      <nonTaxableAmount>3</nonTaxableAmount>
      <sBatchId>sample string 9</sBatchId>
      <sInmateId>sample string 6</sInmateId>
      <sVE_TransactionId>sample string 10</sVE_TransactionId>
      <taxableAmount>5</taxableAmount>
      <transactionId>sample string 1</transactionId>
      <txnType>sample string 11</txnType>
    </CreditsRequest.ACredit>
    <CreditsRequest.ACredit>
      <OriginalSalesID>sample string 2</OriginalSalesID>
      <UTCreatedDateOfOrder>2025-06-24T16:36:27.2978513-05:00</UTCreatedDateOfOrder>
      <amountOfTax>4</amountOfTax>
      <bUseUSGCacheLocation>true</bUseUSGCacheLocation>
      <linesItem>
        <CreditsRequest.ACredit.LineItemCredit>
          <itemDescription>sample string 1</itemDescription>
          <menuNumber>sample string 7</menuNumber>
          <quantityReturned>2</quantityReturned>
          <sExternalItem>sample string 5</sExternalItem>
          <sellingPrice>3</sellingPrice>
          <taxRate>4</taxRate>
          <unitOfMeasure>sample string 6</unitOfMeasure>
        </CreditsRequest.ACredit.LineItemCredit>
        <CreditsRequest.ACredit.LineItemCredit>
          <itemDescription>sample string 1</itemDescription>
          <menuNumber>sample string 7</menuNumber>
          <quantityReturned>2</quantityReturned>
          <sExternalItem>sample string 5</sExternalItem>
          <sellingPrice>3</sellingPrice>
          <taxRate>4</taxRate>
          <unitOfMeasure>sample string 6</unitOfMeasure>
        </CreditsRequest.ACredit.LineItemCredit>
      </linesItem>
      <location>
        <FacilityId>sample string 2</FacilityId>
        <WIWebServiceUrl>sample string 17</WIWebServiceUrl>
        <cellNo>sample string 10</cellNo>
        <docNumber>sample string 4</docNumber>
        <facilityLdapId>sample string 11</facilityLdapId>
        <firstName>sample string 7</firstName>
        <lastName>sample string 8</lastName>
        <livingUnit>sample string 12</livingUnit>
        <longDesc>sample string 6</longDesc>
        <middleName>sample string 9</middleName>
        <primary_code>sample string 13</primary_code>
        <primary_desc>sample string 14</primary_desc>
        <sInmateId>sample string 1</sInmateId>
        <shortDesc>sample string 5</shortDesc>
        <substatus_code>sample string 15</substatus_code>
        <substatus_desc>sample string 16</substatus_desc>
        <usc_facilityid>sample string 3</usc_facilityid>
      </location>
      <nonTaxableAmount>3</nonTaxableAmount>
      <sBatchId>sample string 9</sBatchId>
      <sInmateId>sample string 6</sInmateId>
      <sVE_TransactionId>sample string 10</sVE_TransactionId>
      <taxableAmount>5</taxableAmount>
      <transactionId>sample string 1</transactionId>
      <txnType>sample string 11</txnType>
    </CreditsRequest.ACredit>
  </aCredits>
</CreditsRequest>

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 'CreditsRequest'.

Response Information

Resource Description

CreditsResponse

Name	Type	Additional information
aResponses	Collection of ACreditResponse	None.
sErrorMsg	string	None.
bHasError	boolean	None.
nErrorCode	integer	None.
totalMillisecs	integer	None.
enErrorCode	enERROR	None.
lTransactionId	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "aResponses": [
    {
      "bHasError": true,
      "transactionId": "sample string 2",
      "sErrorMsg": "sample string 3",
      "nErrorCode": 0,
      "wiElapsedMilliseconds": 5,
      "enErrorCode": 0,
      "UTCreatedDateOfOrder": "2025-06-24T16:36:27.5358703-05:00"
    },
    {
      "bHasError": true,
      "transactionId": "sample string 2",
      "sErrorMsg": "sample string 3",
      "nErrorCode": 0,
      "wiElapsedMilliseconds": 5,
      "enErrorCode": 0,
      "UTCreatedDateOfOrder": "2025-06-24T16:36:27.5358703-05:00"
    }
  ],
  "sErrorMsg": "sample string 1",
  "bHasError": true,
  "nErrorCode": 0,
  "totalMillisecs": 4,
  "enErrorCode": 0,
  "lTransactionId": 5
}

application/xml, text/xml

Sample:

<CreditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CNCWrapperBased">
  <bHasError>true</bHasError>
  <enErrorCode>NO_ERROR</enErrorCode>
  <lTransactionId>5</lTransactionId>
  <nErrorCode>0</nErrorCode>
  <sErrorMsg>sample string 1</sErrorMsg>
  <totalMillisecs>4</totalMillisecs>
  <aResponses>
    <CreditsResponse.ACreditResponse>
      <UTCreatedDateOfOrder>2025-06-24T16:36:27.5358703-05:00</UTCreatedDateOfOrder>
      <bHasError>true</bHasError>
      <enErrorCode>NO_ERROR</enErrorCode>
      <nErrorCode>0</nErrorCode>
      <sErrorMsg>sample string 3</sErrorMsg>
      <transactionId>sample string 2</transactionId>
      <wiElapsedMilliseconds>5</wiElapsedMilliseconds>
    </CreditsResponse.ACreditResponse>
    <CreditsResponse.ACreditResponse>
      <UTCreatedDateOfOrder>2025-06-24T16:36:27.5358703-05:00</UTCreatedDateOfOrder>
      <bHasError>true</bHasError>
      <enErrorCode>NO_ERROR</enErrorCode>
      <nErrorCode>0</nErrorCode>
      <sErrorMsg>sample string 3</sErrorMsg>
      <transactionId>sample string 2</transactionId>
      <wiElapsedMilliseconds>5</wiElapsedMilliseconds>
    </CreditsResponse.ACreditResponse>
  </aResponses>
</CreditsResponse>