#Script Pages

<back to all web services

QueryCustomers

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SharpScript

Namespace Global

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of Customer)
            Public Sub New()
                Results = New List(Of Customer)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of Customer)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace SharpScript

        Public Partial Class Customer
            Public Sub New()
                Orders = New List(Of Order)
            End Sub

            Public Overridable Property CustomerId As String
            Public Overridable Property CompanyName As String
            Public Overridable Property Address As String
            Public Overridable Property City As String
            Public Overridable Property Region As String
            Public Overridable Property PostalCode As String
            Public Overridable Property Country As String
            Public Overridable Property Phone As String
            Public Overridable Property Fax As String
            Public Overridable Property Orders As List(Of Order)
        End Class

        Public Partial Class Order
            Public Overridable Property OrderId As Integer
            Public Overridable Property CustomerId As String
            Public Overridable Property OrderDate As Date
            Public Overridable Property Total As Double
        End Class

        Public Partial Class QueryCustomers
            Inherits QueryDb(Of Customer)
            Public Overridable Property CustomerId As String
            Public Overridable Property CompanyNameContains As String
            Public Overridable Property CountryIn As String()
        End Class
    End Namespace
End Namespace

VB.NET QueryCustomers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/QueryCustomers HTTP/1.1 
Host: sharpscript.net 
Accept: application/json
Content-Type: application/json
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: application/json
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":"\/Date(-62135596800000-0000)\/","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"}}}