JiwaAPI

<back to all web services

CR_WarehouseQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/CR_WarehouseRetrieves a list of creditor warehouses.
CR_WarehouseQuery Parameters:
NameParameterData TypeRequiredDescription
WarehouseIDquerystringNo
WarehouseIDStartsWithquerystringNo
WarehouseIDEndsWithquerystringNo
WarehouseIDContainsquerystringNo
WarehouseIDLikequerystringNo
WarehouseIDBetweenquerystring[]No
WarehouseIDInquerystring[]No
CreditorIDquerystringNo
CreditorIDStartsWithquerystringNo
CreditorIDEndsWithquerystringNo
CreditorIDContainsquerystringNo
CreditorIDLikequerystringNo
CreditorIDBetweenquerystring[]No
CreditorIDInquerystring[]No
DescriptionquerystringNo
DescriptionStartsWithquerystringNo
DescriptionEndsWithquerystringNo
DescriptionContainsquerystringNo
DescriptionLikequerystringNo
DescriptionBetweenquerystring[]No
DescriptionInquerystring[]No
Address1querystringNo
Address1StartsWithquerystringNo
Address1EndsWithquerystringNo
Address1ContainsquerystringNo
Address1LikequerystringNo
Address1Betweenquerystring[]No
Address1Inquerystring[]No
Address2querystringNo
Address2StartsWithquerystringNo
Address2EndsWithquerystringNo
Address2ContainsquerystringNo
Address2LikequerystringNo
Address2Betweenquerystring[]No
Address2Inquerystring[]No
Address3querystringNo
Address3StartsWithquerystringNo
Address3EndsWithquerystringNo
Address3ContainsquerystringNo
Address3LikequerystringNo
Address3Betweenquerystring[]No
Address3Inquerystring[]No
Address4querystringNo
Address4StartsWithquerystringNo
Address4EndsWithquerystringNo
Address4ContainsquerystringNo
Address4LikequerystringNo
Address4Betweenquerystring[]No
Address4Inquerystring[]No
PostCodequerystringNo
PostCodeStartsWithquerystringNo
PostCodeEndsWithquerystringNo
PostCodeContainsquerystringNo
PostCodeLikequerystringNo
PostCodeBetweenquerystring[]No
PostCodeInquerystring[]No
NotesquerystringNo
NotesStartsWithquerystringNo
NotesEndsWithquerystringNo
NotesContainsquerystringNo
NotesLikequerystringNo
NotesBetweenquerystring[]No
NotesInquerystring[]No
CourierDetailsquerystringNo
CourierDetailsStartsWithquerystringNo
CourierDetailsEndsWithquerystringNo
CourierDetailsContainsquerystringNo
CourierDetailsLikequerystringNo
CourierDetailsBetweenquerystring[]No
CourierDetailsInquerystring[]No
DefaultItemquerybool?No
DefaultDelDaysqueryshort?No
DefaultDelDaysGreaterThanOrEqualToqueryshort?No
DefaultDelDaysGreaterThanqueryshort?No
DefaultDelDaysLessThanqueryshort?No
DefaultDelDaysLessThanOrEqualToqueryshort?No
DefaultDelDaysNotEqualToqueryshort?No
DefaultDelDaysBetweenqueryNullable<Int16>[]No
DefaultDelDaysInqueryNullable<Int16>[]No
CountryquerystringNo
CountryStartsWithquerystringNo
CountryEndsWithquerystringNo
CountryContainsquerystringNo
CountryLikequerystringNo
CountryBetweenquerystring[]No
CountryInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
CR_Warehouse Parameters:
NameParameterData TypeRequiredDescription
WarehouseIDformstringNo
CreditorIDformstringNo
DescriptionformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostCodeformstringNo
NotesformstringNo
CourierDetailsformstringNo
DefaultItemformbool?No
DefaultDelDaysformshort?No
CountryformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the 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.

GET /Queries/CR_Warehouse HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCR_Warehouse7kRqkrSv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
    <d2p1:CR_Warehouse>
      <d2p1:_x003C_Address1_x003E_k__BackingField>String</d2p1:_x003C_Address1_x003E_k__BackingField>
      <d2p1:_x003C_Address2_x003E_k__BackingField>String</d2p1:_x003C_Address2_x003E_k__BackingField>
      <d2p1:_x003C_Address3_x003E_k__BackingField>String</d2p1:_x003C_Address3_x003E_k__BackingField>
      <d2p1:_x003C_Address4_x003E_k__BackingField>String</d2p1:_x003C_Address4_x003E_k__BackingField>
      <d2p1:_x003C_Country_x003E_k__BackingField>String</d2p1:_x003C_Country_x003E_k__BackingField>
      <d2p1:_x003C_CourierDetails_x003E_k__BackingField>String</d2p1:_x003C_CourierDetails_x003E_k__BackingField>
      <d2p1:_x003C_CreditorID_x003E_k__BackingField>String</d2p1:_x003C_CreditorID_x003E_k__BackingField>
      <d2p1:_x003C_DefaultDelDays_x003E_k__BackingField>0</d2p1:_x003C_DefaultDelDays_x003E_k__BackingField>
      <d2p1:_x003C_DefaultItem_x003E_k__BackingField>false</d2p1:_x003C_DefaultItem_x003E_k__BackingField>
      <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_Notes_x003E_k__BackingField>String</d2p1:_x003C_Notes_x003E_k__BackingField>
      <d2p1:_x003C_PostCode_x003E_k__BackingField>String</d2p1:_x003C_PostCode_x003E_k__BackingField>
      <d2p1:_x003C_WarehouseID_x003E_k__BackingField>String</d2p1:_x003C_WarehouseID_x003E_k__BackingField>
    </d2p1:CR_Warehouse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCR_Warehouse7kRqkrSv>