digitaluapi

<back to all web services

SegmentsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/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

Namespace Global

    Namespace digitaluapi.ServiceModel

        <DataContract>
        Public Partial Class SegmentsAdd
            <DataMember(Order:=2)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=3)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property Name As String

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

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

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

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

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

VB.NET SegmentsAdd DTOs

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 /segments HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TenantsId: 0,
	Name: String,
	IsCustom: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TenantsId: 0,
	Name: String,
	IsCustom: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}