JiwaAPI

<back to all web services

SY_UserProfileQuery

Requires Authentication
SY_UserProfileQuery Parameters:
NameParameterData TypeRequiredDescription
ProfileIDquerystringNo
ProfileIDStartsWithquerystringNo
ProfileIDEndsWithquerystringNo
ProfileIDContainsquerystringNo
ProfileIDLikequerystringNo
ProfileIDBetweenquerystring[]No
ProfileIDInquerystring[]No
LastSavedDateTimequeryDateTime?No
LastSavedDateTimeGreaterThanOrEqualToqueryDateTime?No
LastSavedDateTimeGreaterThanqueryDateTime?No
LastSavedDateTimeLessThanqueryDateTime?No
LastSavedDateTimeLessThanOrEqualToqueryDateTime?No
LastSavedDateTimeNotEqualToqueryDateTime?No
LastSavedDateTimeBetweenqueryDateTime[]No
LastSavedDateTimeInqueryDateTime[]No
UserIDquerystringNo
UserIDStartsWithquerystringNo
UserIDEndsWithquerystringNo
UserIDContainsquerystringNo
UserIDLikequerystringNo
UserIDBetweenquerystring[]No
UserIDInquerystring[]No
SectionquerystringNo
SectionStartsWithquerystringNo
SectionEndsWithquerystringNo
SectionContainsquerystringNo
SectionLikequerystringNo
SectionBetweenquerystring[]No
SectionInquerystring[]No
IDKeyquerystringNo
IDKeyStartsWithquerystringNo
IDKeyEndsWithquerystringNo
IDKeyContainsquerystringNo
IDKeyLikequerystringNo
IDKeyBetweenquerystring[]No
IDKeyInquerystring[]No
ContentsquerystringNo
ContentsStartsWithquerystringNo
ContentsEndsWithquerystringNo
ContentsContainsquerystringNo
ContentsLikequerystringNo
ContentsBetweenquerystring[]No
ContentsInquerystring[]No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SY_UserProfile Parameters:
NameParameterData TypeRequiredDescription
ProfileIDformstringNo
LastSavedDateTimeformDateTimeNo
UserIDformstringNo
SectionformstringNo
IDKeyformstringNo
ContentsformstringNo
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/SY_UserProfileQuery HTTP/1.1 
Host: api.jiwa.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SY_UserProfileQuery 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>
  <Contents>String</Contents>
  <ContentsBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContentsBetween>
  <ContentsContains>String</ContentsContains>
  <ContentsEndsWith>String</ContentsEndsWith>
  <ContentsIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContentsIn>
  <ContentsLike>String</ContentsLike>
  <ContentsStartsWith>String</ContentsStartsWith>
  <IDKey>String</IDKey>
  <IDKeyBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IDKeyBetween>
  <IDKeyContains>String</IDKeyContains>
  <IDKeyEndsWith>String</IDKeyEndsWith>
  <IDKeyIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </IDKeyIn>
  <IDKeyLike>String</IDKeyLike>
  <IDKeyStartsWith>String</IDKeyStartsWith>
  <LastSavedDateTime>0001-01-01T00:00:00</LastSavedDateTime>
  <LastSavedDateTimeBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeBetween>
  <LastSavedDateTimeGreaterThan>0001-01-01T00:00:00</LastSavedDateTimeGreaterThan>
  <LastSavedDateTimeGreaterThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeGreaterThanOrEqualTo>
  <LastSavedDateTimeIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </LastSavedDateTimeIn>
  <LastSavedDateTimeLessThan>0001-01-01T00:00:00</LastSavedDateTimeLessThan>
  <LastSavedDateTimeLessThanOrEqualTo>0001-01-01T00:00:00</LastSavedDateTimeLessThanOrEqualTo>
  <LastSavedDateTimeNotEqualTo>0001-01-01T00:00:00</LastSavedDateTimeNotEqualTo>
  <ProfileID>String</ProfileID>
  <ProfileIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProfileIDBetween>
  <ProfileIDContains>String</ProfileIDContains>
  <ProfileIDEndsWith>String</ProfileIDEndsWith>
  <ProfileIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ProfileIDIn>
  <ProfileIDLike>String</ProfileIDLike>
  <ProfileIDStartsWith>String</ProfileIDStartsWith>
  <Section>String</Section>
  <SectionBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SectionBetween>
  <SectionContains>String</SectionContains>
  <SectionEndsWith>String</SectionEndsWith>
  <SectionIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SectionIn>
  <SectionLike>String</SectionLike>
  <SectionStartsWith>String</SectionStartsWith>
  <UserID>String</UserID>
  <UserIDBetween xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserIDBetween>
  <UserIDContains>String</UserIDContains>
  <UserIDEndsWith>String</UserIDEndsWith>
  <UserIDIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UserIDIn>
  <UserIDLike>String</UserIDLike>
  <UserIDStartsWith>String</UserIDStartsWith>
</SY_UserProfileQuery>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfSY_UserProfile7kRqkrSv 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:SY_UserProfile>
      <d2p1:_x003C_Contents_x003E_k__BackingField>String</d2p1:_x003C_Contents_x003E_k__BackingField>
      <d2p1:_x003C_IDKey_x003E_k__BackingField>String</d2p1:_x003C_IDKey_x003E_k__BackingField>
      <d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_LastSavedDateTime_x003E_k__BackingField>
      <d2p1:_x003C_ProfileID_x003E_k__BackingField>String</d2p1:_x003C_ProfileID_x003E_k__BackingField>
      <d2p1:_x003C_Section_x003E_k__BackingField>String</d2p1:_x003C_Section_x003E_k__BackingField>
      <d2p1:_x003C_UserID_x003E_k__BackingField>String</d2p1:_x003C_UserID_x003E_k__BackingField>
    </d2p1:SY_UserProfile>
  </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>
</QueryResponseOfSY_UserProfile7kRqkrSv>