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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/QueryCustomers HTTP/1.1 
Host: sharpscript.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	customerId: String,
	companyNameContains: String,
	countryIn: 
	[
		String
	],
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			customerId: String,
			companyName: String,
			address: String,
			city: String,
			region: String,
			postalCode: String,
			country: String,
			phone: String,
			fax: String,
			orders: 
			[
				{
					orderId: 0,
					customerId: String,
					orderDate: 0001-01-01,
					total: 0
				}
			]
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}