JiwaAPI

<back to all web services

DB_DeliveryAddress_DeliveryAreaSelectionQuery

Requires Authentication
DB_DeliveryAddress_DeliveryAreaSelectionQuery Parameters:
NameParameterData TypeRequiredDescription
DB_DeliveryAddress_DeliveryIDquerystringNo
DB_DeliveryAddress_DeliveryIDStartsWithquerystringNo
DB_DeliveryAddress_DeliveryIDEndsWithquerystringNo
DB_DeliveryAddress_DeliveryIDContainsquerystringNo
DB_DeliveryAddress_DeliveryIDLikequerystringNo
DB_DeliveryAddress_DeliveryIDBetweenquerystring[]No
DB_DeliveryAddress_DeliveryIDInquerystring[]No
UseSpecificDeliveryAreaquerybool?No
DeliveryArea_RecIDqueryGuid?No
DeliveryArea_RecIDInqueryNullable<Guid>[]No
DefaultTimeAtStopqueryint?No
DefaultTimeAtStopGreaterThanOrEqualToqueryint?No
DefaultTimeAtStopGreaterThanqueryint?No
DefaultTimeAtStopLessThanqueryint?No
DefaultTimeAtStopLessThanOrEqualToqueryint?No
DefaultTimeAtStopNotEqualToqueryint?No
DefaultTimeAtStopBetweenqueryNullable<Int32>[]No
DefaultTimeAtStopInqueryNullable<Int32>[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
DB_DeliveryAddress_DeliveryAreaSelection Parameters:
NameParameterData TypeRequiredDescription
DB_DeliveryAddress_DeliveryIDformstringNo
UseSpecificDeliveryAreaformboolNo
DeliveryArea_RecIDformGuid?No
DefaultTimeAtStopformint?No
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.

POST /xml/reply/DB_DeliveryAddress_DeliveryAreaSelectionQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DB_DeliveryAddress_DeliveryAreaSelectionQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JiwaFinancials.Jiwa.JiwaServiceModel.Tables">
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <DB_DeliveryAddress_DeliveryID>String</DB_DeliveryAddress_DeliveryID>
  <DB_DeliveryAddress_DeliveryIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DB_DeliveryAddress_DeliveryIDBetween>
  <DB_DeliveryAddress_DeliveryIDContains>String</DB_DeliveryAddress_DeliveryIDContains>
  <DB_DeliveryAddress_DeliveryIDEndsWith>String</DB_DeliveryAddress_DeliveryIDEndsWith>
  <DB_DeliveryAddress_DeliveryIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DB_DeliveryAddress_DeliveryIDIn>
  <DB_DeliveryAddress_DeliveryIDLike>String</DB_DeliveryAddress_DeliveryIDLike>
  <DB_DeliveryAddress_DeliveryIDStartsWith>String</DB_DeliveryAddress_DeliveryIDStartsWith>
  <DefaultTimeAtStop>0</DefaultTimeAtStop>
  <DefaultTimeAtStopBetween xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </DefaultTimeAtStopBetween>
  <DefaultTimeAtStopGreaterThan>0</DefaultTimeAtStopGreaterThan>
  <DefaultTimeAtStopGreaterThanOrEqualTo>0</DefaultTimeAtStopGreaterThanOrEqualTo>
  <DefaultTimeAtStopIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:int>0</d2p1:int>
  </DefaultTimeAtStopIn>
  <DefaultTimeAtStopLessThan>0</DefaultTimeAtStopLessThan>
  <DefaultTimeAtStopLessThanOrEqualTo>0</DefaultTimeAtStopLessThanOrEqualTo>
  <DefaultTimeAtStopNotEqualTo>0</DefaultTimeAtStopNotEqualTo>
  <DeliveryArea_RecID>00000000-0000-0000-0000-000000000000</DeliveryArea_RecID>
  <DeliveryArea_RecIDIn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </DeliveryArea_RecIDIn>
  <UseSpecificDeliveryArea>false</UseSpecificDeliveryArea>
</DB_DeliveryAddress_DeliveryAreaSelectionQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfDB_DeliveryAddress_DeliveryAreaSelection7kRqkrSv 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:DB_DeliveryAddress_DeliveryAreaSelection>
      <d2p1:_x003C_DB_DeliveryAddress_DeliveryID_x003E_k__BackingField>String</d2p1:_x003C_DB_DeliveryAddress_DeliveryID_x003E_k__BackingField>
      <d2p1:_x003C_DefaultTimeAtStop_x003E_k__BackingField>0</d2p1:_x003C_DefaultTimeAtStop_x003E_k__BackingField>
      <d2p1:_x003C_DeliveryArea_RecID_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_DeliveryArea_RecID_x003E_k__BackingField>
      <d2p1:_x003C_UseSpecificDeliveryArea_x003E_k__BackingField>false</d2p1:_x003C_UseSpecificDeliveryArea_x003E_k__BackingField>
    </d2p1:DB_DeliveryAddress_DeliveryAreaSelection>
  </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>
</QueryResponseOfDB_DeliveryAddress_DeliveryAreaSelection7kRqkrSv>