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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Results":[{"WarehouseID":"String","CreditorID":"String","Description":"String","Address1":"String","Address2":"String","Address3":"String","Address4":"String","PostCode":"String","Notes":"String","CourierDetails":"String","DefaultItem":false,"DefaultDelDays":0,"Country":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}