digitaluapi

SegmentsAutoQueryLookup

**Requires Authentication**
Requires the role:	Client

The following routes are available for this service:
GET	/auto/segments/{Id}
GET	/auto/segments

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Imports digitaluapi.ServiceModel.Types

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class SegmentsAutoQueryLookup
            Inherits QueryDb(Of Segments)
            Implements IGet
            <DataMember(Order:=1)>
            Public Overridable Property Id As Integer?

            <DataMember(Order:=2)>
            Public Overridable Property TenantsId As Integer
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

        Public Partial Class CampaignCustomersView
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long?

            <DataMember(Order:=2)>
            Public Overridable Property Name As String

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

            <DataMember(Order:=4)>
            Public Overridable Property CustomersId As Long?

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

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

            <DataMember(Order:=7)>
            Public Overridable Property IdNumber As String

            <DataMember(Order:=8)>
            Public Overridable Property PassportNumber As String

            <DataMember(Order:=9)>
            Public Overridable Property Email As String

            <DataMember(Order:=10)>
            Public Overridable Property MobileNumber As String

            <DataMember(Order:=11)>
            Public Overridable Property CustomerUniqueIdentifier As String

            <DataMember(Order:=12)>
            Public Overridable Property CustomerPublicAccessGuid As Guid?

            <DataMember(Order:=13)>
            Public Overridable Property CampaignPublicAccessGuid As Guid?

            <DataMember(Order:=14)>
            Public Overridable Property TenantsId As Integer?
        End Class

        Public Partial Class Segments
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(Tenants))>
            Public Overridable Property TenantsId As Integer

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

            <DataMember(Order:=4)>
            Public Overridable Property IsCustom As Boolean?
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            <DataMember(Order:=1)>
            Public Overridable Property Skip As Integer?

            <DataMember(Order:=2)>
            Public Overridable Property Take As 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 T)
            <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 CampaignCustomersView)

            <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
End Namespace

VB.NET SegmentsAutoQueryLookup DTOs

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

HTTP + OTHER

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

GET /auto/segments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"TenantsId":0,"Name":"String","IsCustom":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}