#Script Pages

<back to all web services

QueryCustomers

QueryCustomers Parameters:
NameParameterData TypeRequiredDescription
CustomerIdquerystringYes
CompanyNameContainsquerystringYes
CountryInquerystring[]Yes
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Customer Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformstringYes
CompanyNameformstringYes
AddressformstringYes
CityformstringYes
RegionformstringYes
PostalCodeformstringYes
CountryformstringYes
PhoneformstringYes
FaxformstringYes
OrdersformList<Order>Yes
Order Parameters:
NameParameterData TypeRequiredDescription
OrderIdformintNo
CustomerIdformstringYes
OrderDateformDateTimeNo
TotalformdoubleNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<GithubRepo>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
GithubRepo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
DescriptionformstringYes
HomepageformstringYes
LanguageformstringYes
Watchers_CountformintNo
Stargazes_CountformintNo
Forks_CountformintNo
Open_Issues_CountformintNo
SizeformintNo
Full_NameformstringYes
Created_atformDateTimeNo
Pushed_AtformDateTime?No
Updated_AtformDateTime?No
Has_issuesformboolNo
Has_DownloadsformboolNo
Has_WikiformboolNo
Has_PagesformboolNo
ForkformboolNo
OwnerformGithubUserYes
Svn_UrlformstringYes
Mirror_UrlformstringYes
UrlformstringYes
Ssh_UrlformstringYes
Html_UrlformstringYes
Clone_UrlformstringYes
Git_UrlformstringYes
PrivateformboolNo
GithubUser Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LoginformstringYes
Avatar_UrlformstringYes
UrlformstringYes
Followersformint?No
Followingformint?No
TypeformstringYes
Public_Gistsformint?No
LocationformstringYes
CompanyformstringYes
Html_UrlformstringYes
Public_Reposformint?No
Created_AtformDateTime?No
BlogformstringYes
EmailformstringYes
NameformstringYes
Hireableformbool?No
Gravatar_IdformstringYes
BioformstringYes

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/QueryCustomers HTTP/1.1 
Host: sharpscript.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharpScript">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <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>
  <CompanyNameContains>String</CompanyNameContains>
  <CountryIn xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CountryIn>
  <CustomerId>String</CustomerId>
</QueryCustomers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCustomerA703xr44 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/SharpScript">
    <d2p1:Customer>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:Orders>
        <d2p1:Order>
          <d2p1:CustomerId>String</d2p1:CustomerId>
          <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
          <d2p1:OrderId>0</d2p1:OrderId>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Order>
      </d2p1:Orders>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:Customer>
  </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>
</QueryResponseOfCustomerA703xr44>