| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | query | string | Yes | |
| CompanyNameContains | query | string | Yes | |
| CountryIn | query | string[] | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Skip | form | int? | No | |
| Take | form | int? | No | |
| OrderBy | form | string | No | |
| OrderByDesc | form | string | No | |
| Include | form | string | No | |
| Fields | form | string | No | |
| Meta | form | Dictionary<string, string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | form | string | Yes | |
| CompanyName | form | string | Yes | |
| Address | form | string | Yes | |
| City | form | string | Yes | |
| Region | form | string | Yes | |
| PostalCode | form | string | Yes | |
| Country | form | string | Yes | |
| Phone | form | string | Yes | |
| Fax | form | string | Yes | |
| Orders | form | List<Order> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderId | form | int | No | |
| CustomerId | form | string | Yes | |
| OrderDate | form | DateTime | No | |
| Total | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<GithubRepo> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Homepage | form | string | Yes | |
| Language | form | string | Yes | |
| Watchers_Count | form | int | No | |
| Stargazes_Count | form | int | No | |
| Forks_Count | form | int | No | |
| Open_Issues_Count | form | int | No | |
| Size | form | int | No | |
| Full_Name | form | string | Yes | |
| Created_at | form | DateTime | No | |
| Pushed_At | form | DateTime? | No | |
| Updated_At | form | DateTime? | No | |
| Has_issues | form | bool | No | |
| Has_Downloads | form | bool | No | |
| Has_Wiki | form | bool | No | |
| Has_Pages | form | bool | No | |
| Fork | form | bool | No | |
| Owner | form | GithubUser | Yes | |
| Svn_Url | form | string | Yes | |
| Mirror_Url | form | string | Yes | |
| Url | form | string | Yes | |
| Ssh_Url | form | string | Yes | |
| Html_Url | form | string | Yes | |
| Clone_Url | form | string | Yes | |
| Git_Url | form | string | Yes | |
| Private | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Login | form | string | Yes | |
| Avatar_Url | form | string | Yes | |
| Url | form | string | Yes | |
| Followers | form | int? | No | |
| Following | form | int? | No | |
| Type | form | string | Yes | |
| Public_Gists | form | int? | No | |
| Location | form | string | Yes | |
| Company | form | string | Yes | |
| Html_Url | form | string | Yes | |
| Public_Repos | form | int? | No | |
| Created_At | form | DateTime? | No | |
| Blog | form | string | Yes | |
| form | string | Yes | ||
| Name | form | string | Yes | |
| Hireable | form | bool? | No | |
| Gravatar_Id | form | string | Yes | |
| Bio | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}