JiwaAPI

<back to all web services

PhysicalWarehousesQuery

Requires Authentication
The following routes are available for this service:
GET/Queries/PhysicalWarehousesPhysical warehouses with their Show On Web flag, address, phone, location, region, trading hours and special days (AutoQuery: Skip, Take, OrderBy, Fields, Include=Total and column filters).
PhysicalWarehousesQuery Parameters:
NameParameterData TypeRequiredDescription
IN_PhysicalIDquerystringNo
IN_PhysicalIDInquerystring[]No
WebEnabledquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
v_TFM_PhysicalWarehouses Parameters:
NameParameterData TypeRequiredDescription
IN_PhysicalIDformstringNo
DescriptionformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
PostCodeformstringNo
PhoneformstringNo
LastSavedDateTimeformDateTime?No
WebEnabledformbool?No
Latitudeformdecimal?No
Longitudeformdecimal?No
RegionNameformstringNo
TradingHoursformstringNo
SpecialDaysformstringNo
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/PhysicalWarehouses HTTP/1.1 
Host: testapi.wagga.redpoint.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfv_TFM_PhysicalWarehouses6LgwzCd1 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">
    <d2p1:v_TFM_PhysicalWarehouses>
      <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_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
      <d2p1:_x003C_IN_PhysicalID_x003E_k__BackingField>String</d2p1:_x003C_IN_PhysicalID_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_Latitude_x003E_k__BackingField>0</d2p1:_x003C_Latitude_x003E_k__BackingField>
      <d2p1:_x003C_Longitude_x003E_k__BackingField>0</d2p1:_x003C_Longitude_x003E_k__BackingField>
      <d2p1:_x003C_Phone_x003E_k__BackingField>String</d2p1:_x003C_Phone_x003E_k__BackingField>
      <d2p1:_x003C_PostCode_x003E_k__BackingField>String</d2p1:_x003C_PostCode_x003E_k__BackingField>
      <d2p1:_x003C_RegionName_x003E_k__BackingField>String</d2p1:_x003C_RegionName_x003E_k__BackingField>
      <d2p1:_x003C_SpecialDays_x003E_k__BackingField>String</d2p1:_x003C_SpecialDays_x003E_k__BackingField>
      <d2p1:_x003C_TradingHours_x003E_k__BackingField>String</d2p1:_x003C_TradingHours_x003E_k__BackingField>
      <d2p1:_x003C_WebEnabled_x003E_k__BackingField>false</d2p1:_x003C_WebEnabled_x003E_k__BackingField>
    </d2p1:v_TFM_PhysicalWarehouses>
  </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>
</QueryResponseOfv_TFM_PhysicalWarehouses6LgwzCd1>