Trendsic Platform Service

<back to all web services

CustomerAppNotifRequest

The following routes are available for this service:
POST/v1/c/app/notif
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CourierBookLevel
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Ready As String
            Public Overridable Property WithinMin As Integer
            Public Overridable Property InBy As String
            Public Overridable Property Surcharge As Decimal
            Public Overridable Property Days As List(Of Integer) = New List(Of Integer)
            Public Overridable Property DeadlineMin As Integer?
        End Class

        Public Partial Class CourierBookOrderResponse
            Public Overridable Property Done As Boolean
            Public Overridable Property NeedsAction As Boolean
            Public Overridable Property ClientSecret As String
            Public Overridable Property SetupIntentId As String
            Public Overridable Property Code As String
            Public Overridable Property TrackUrl As String
            Public Overridable Property IcsUrl As String
            Public Overridable Property WindowText As String
            Public Overridable Property Promise As String
            Public Overridable Property Total As Decimal
            Public Overridable Property PayTiming As String
            Public Overridable Property CardLast4 As String
            Public Overridable Property Repeats As String
            Public Overridable Property LinkSentBy As String
            Public Overridable Property ReopenStep As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CourierBookPageView
            Public Overridable Property Available As Boolean
            Public Overridable Property BookingOn As Boolean
            Public Overridable Property Business As CourierTrackBusiness
            Public Overridable Property Profile As CourierBookProfile
            Public Overridable Property Profiles As List(Of CourierBookProfileLink) = New List(Of CourierBookProfileLink)
            Public Overridable Property CardEnabled As Boolean
            Public Overridable Property PublishableKey As String
            Public Overridable Property AppUrl As String
            Public Overridable Property Today As String
            Public Overridable Property Weekday As Integer
            Public Overridable Property NowMin As Integer
        End Class

        Public Partial Class CourierBookProfile
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Shape As String
            Public Overridable Property Template As String
            Public Overridable Property UnitOne As String
            Public Overridable Property UnitMany As String
            Public Overridable Property UnitOneEs As String
            Public Overridable Property UnitManyEs As String
            Public Overridable Property FacilityNoun As String
            Public Overridable Property FacilityNounEs As String
            Public Overridable Property FacilityName As String
            Public Overridable Property Levels As List(Of CourierBookLevel) = New List(Of CourierBookLevel)
            Public Overridable Property Asap As Boolean
            Public Overridable Property Recurring As Boolean
            Public Overridable Property PayTiming As String
            Public Overridable Property FinalAfterCount As Boolean
            Public Overridable Property CancelFee As Decimal
            Public Overridable Property MissedFee As Decimal
            Public Overridable Property MissedWaitMin As Integer
            Public Overridable Property ServiceArea As List(Of String) = New List(Of String)
            Public Overridable Property Zips As List(Of String) = New List(Of String)
            Public Overridable Property Handoffs As HandoffOptions
        End Class

        Public Partial Class CourierBookProfileLink
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Shape As String
        End Class

        Public Partial Class CourierCustomerRow
            Public Overridable Property ContactId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
            Public Overridable Property BillingMode As String
            Public Overridable Property AccountCode As String
            Public Overridable Property Orders As Integer
            Public Overridable Property LastOrderAt As Date?
            Public Overridable Property Unbilled As Integer
            Public Overridable Property UnbilledAmount As Decimal
            Public Overridable Property Cards As Integer
        End Class

        Public Partial Class CourierTrackBusiness
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
        End Class

        Public Partial Class CustomerAppAddress
            Public Overridable Property Id As Integer
            Public Overridable Property Label As String
            Public Overridable Property Street As String
            Public Overridable Property Unit As String
            Public Overridable Property City As String
            Public Overridable Property Zip As String
            Public Overridable Property Lat As Decimal?
            Public Overridable Property Lng As Decimal?
            Public Overridable Property InArea As Boolean
        End Class

        Public Partial Class CustomerAppBoot
            Public Overridable Property Profile As String
            Public Overridable Property Available As Boolean
            Public Overridable Property Reason As String
            Public Overridable Property AuthMethod As String
            Public Overridable Property Slug As String
            Public Overridable Property Page As CourierBookPageView
            Public Overridable Property ManifestUrl As String
        End Class

        Public Partial Class CustomerAppCard
            Public Overridable Property Id As Integer
            Public Overridable Property Label As String
            Public Overridable Property Brand As String
            Public Overridable Property Last4 As String
            Public Overridable Property IsDefault As Boolean
        End Class

        Public Partial Class CustomerAppInvoice
            Public Overridable Property Uid As Guid
            Public Overridable Property Number As String
            Public Overridable Property DateText As String
            Public Overridable Property Total As Decimal
            Public Overridable Property Balance As Decimal
            Public Overridable Property Paid As Boolean
        End Class

        Public Partial Class CustomerAppMe
            Public Overridable Property ContactId As Integer
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
            Public Overridable Property NeedsName As Boolean
            Public Overridable Property BillingMode As String
            Public Overridable Property AccountCode As String
            Public Overridable Property Addresses As List(Of CustomerAppAddress) = New List(Of CustomerAppAddress)
            Public Overridable Property Cards As List(Of CustomerAppCard) = New List(Of CustomerAppCard)
            Public Overridable Property Notif As CustomerAppNotif
            Public Overridable Property Orders As List(Of CustomerAppOrder) = New List(Of CustomerAppOrder)
            Public Overridable Property Recurring As List(Of CustomerAppRecurrence) = New List(Of CustomerAppRecurrence)
            Public Overridable Property Invoices As List(Of CustomerAppInvoice) = New List(Of CustomerAppInvoice)
            Public Overridable Property Today As String
            Public Overridable Property NowMin As Integer
        End Class

        Public Partial Class CustomerAppNotif
            Public Overridable Property Texts As Boolean
            Public Overridable Property Push As Boolean
            Public Overridable Property Promos As Boolean
        End Class

        Public Partial Class CustomerAppNotifRequest
            Inherits CustomerAppSessionRequest
            Public Overridable Property Key As String
            Public Overridable Property [On] As Boolean
        End Class

        Public Partial Class CustomerAppOrder
            Public Overridable Property Id As Integer
            Public Overridable Property Code As String
            Public Overridable Property Status As String
            Public Overridable Property State As String
            Public Overridable Property Active As Boolean
            Public Overridable Property LevelCode As String
            Public Overridable Property LevelName As String
            Public Overridable Property Units As Integer
            Public Overridable Property UnitsFound As Integer?
            Public Overridable Property Address As String
            Public Overridable Property Unit As String
            Public Overridable Property Zip As String
            Public Overridable Property DropAddress As String
            Public Overridable Property RecipientName As String
            Public Overridable Property Handoff As String
            Public Overridable Property IsAsap As Boolean
            Public Overridable Property DayIx As Integer
            Public Overridable Property DateText As String
            Public Overridable Property StartMin As Integer?
            Public Overridable Property EndMin As Integer?
            Public Overridable Property DriverFirstName As String
            Public Overridable Property EtaMin As Integer?
            Public Overridable Property Promise As String
            Public Overridable Property PayMode As String
            Public Overridable Property Amount As Decimal
            Public Overridable Property Charged As Decimal?
            Public Overridable Property Tip As Decimal?
            Public Overridable Property CardLast4 As String
            Public Overridable Property RecurrenceId As Integer?
            Public Overridable Property Steps As List(Of CustomerAppStep) = New List(Of CustomerAppStep)
        End Class

        Public Partial Class CustomerAppRecurrence
            Public Overridable Property Id As Integer
            Public Overridable Property Weekday As Integer
            Public Overridable Property StartMin As Integer
            Public Overridable Property EndMin As Integer
            Public Overridable Property Cadence As String
            Public Overridable Property LevelCode As String
            Public Overridable Property Units As Integer
            Public Overridable Property Handoff As String
            Public Overridable Property Address As String
            Public Overridable Property Paused As Boolean
            Public Overridable Property PayMode As String
            Public Overridable Property CardLast4 As String
            Public Overridable Property NextDate As String
            Public Overridable Property SkippedDate As String
            Public Overridable Property AheadDays As Integer
        End Class

        Public Partial Class CustomerAppResponse
            Public Overridable Property Boot As CustomerAppBoot
            Public Overridable Property Customer As CustomerAppMe
            Public Overridable Property Addresses As List(Of CustomerAppAddress) = New List(Of CustomerAppAddress)
            Public Overridable Property Cards As List(Of CustomerAppCard) = New List(Of CustomerAppCard)
            Public Overridable Property Notif As CustomerAppNotif
            Public Overridable Property Recurring As List(Of CustomerAppRecurrence) = New List(Of CustomerAppRecurrence)
            Public Overridable Property Booked As CourierBookOrderResponse
            Public Overridable Property Sent As Boolean
            Public Overridable Property Token As String
            Public Overridable Property NeedsName As Boolean
            Public Overridable Property Name As String
            Public Overridable Property Url As String
            Public Overridable Property ClientSecret As String
            Public Overridable Property PublishableKey As String
            Public Overridable Property Message As String
            Public Overridable Property ReopenStep As String
            Public Overridable Property Customers As List(Of CourierCustomerRow) = New List(Of CourierCustomerRow)
            Public Overridable Property Run As RunResult
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CustomerAppSessionRequest
            Public Overridable Property Slug As String
            Public Overridable Property Profile As String
        End Class

        Public Partial Class CustomerAppStep
            Public Overridable Property Key As String
            Public Overridable Property Done As Boolean
            Public Overridable Property Time As String
        End Class
    End Namespace
End Namespace

VB.NET CustomerAppNotifRequest 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.

POST /v1/c/app/notif HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Key":"String","On":false,"Slug":"String","Profile":"String"}

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

{"Boot":{"Profile":"String","Available":false,"Reason":"String","AuthMethod":"String","Slug":"String","Page":{"Available":false,"BookingOn":false,"Business":{"Name":"String","Phone":"String"},"Profile":{"Code":"String","Name":"String","Shape":"String","Template":"String","UnitOne":"String","UnitMany":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNoun":"String","FacilityNounEs":"String","FacilityName":"String","Levels":[{"Code":"String","Name":"String","Ready":"String","WithinMin":0,"InBy":"String","Surcharge":0,"Days":[0],"DeadlineMin":0}],"Asap":false,"Recurring":false,"PayTiming":"String","FinalAfterCount":false,"CancelFee":0,"MissedFee":0,"MissedWaitMin":0,"ServiceArea":["String"],"Zips":["String"],"Handoffs":{"Hand":false,"Porch":false,"Desk":false,"SigRequired":false,"IdRequired":false,"CodeRequired":false}},"Profiles":[{"Code":"String","Name":"String","Shape":"String"}],"CardEnabled":false,"PublishableKey":"String","AppUrl":"String","Today":"String","Weekday":0,"NowMin":0},"ManifestUrl":"String"},"Customer":{"ContactId":0,"FirstName":"String","LastName":"String","Name":"String","Phone":"String","NeedsName":false,"BillingMode":"String","AccountCode":"String","Addresses":[{"Id":0,"Label":"String","Street":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"InArea":false}],"Cards":[{"Id":0,"Label":"String","Brand":"String","Last4":"String","IsDefault":false}],"Notif":{"Texts":false,"Push":false,"Promos":false},"Orders":[{"Id":0,"Code":"String","Status":"String","State":"String","Active":false,"LevelCode":"String","LevelName":"String","Units":0,"UnitsFound":0,"Address":"String","Unit":"String","Zip":"String","DropAddress":"String","RecipientName":"String","Handoff":"String","IsAsap":false,"DayIx":0,"DateText":"String","StartMin":0,"EndMin":0,"DriverFirstName":"String","EtaMin":0,"Promise":"String","PayMode":"String","Amount":0,"Charged":0,"Tip":0,"CardLast4":"String","RecurrenceId":0,"Steps":[{"Key":"String","Done":false,"Time":"String"}]}],"Recurring":[{"Id":0,"Weekday":0,"StartMin":0,"EndMin":0,"Cadence":"String","LevelCode":"String","Units":0,"Handoff":"String","Address":"String","Paused":false,"PayMode":"String","CardLast4":"String","NextDate":"String","SkippedDate":"String","AheadDays":0}],"Invoices":[{"Uid":"00000000000000000000000000000000","Number":"String","DateText":"String","Total":0,"Balance":0,"Paid":false}],"Today":"String","NowMin":0},"Addresses":[{"Id":0,"Label":"String","Street":"String","Unit":"String","City":"String","Zip":"String","Lat":0,"Lng":0,"InArea":false}],"Cards":[{"Id":0,"Label":"String","Brand":"String","Last4":"String","IsDefault":false}],"Notif":{"Texts":false,"Push":false,"Promos":false},"Recurring":[{"Id":0,"Weekday":0,"StartMin":0,"EndMin":0,"Cadence":"String","LevelCode":"String","Units":0,"Handoff":"String","Address":"String","Paused":false,"PayMode":"String","CardLast4":"String","NextDate":"String","SkippedDate":"String","AheadDays":0}],"Booked":{"Done":false,"NeedsAction":false,"ClientSecret":"String","SetupIntentId":"String","Code":"String","TrackUrl":"String","IcsUrl":"String","WindowText":"String","Promise":"String","Total":0,"PayTiming":"String","CardLast4":"String","Repeats":"String","LinkSentBy":"String","ReopenStep":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}},"Sent":false,"Token":"String","NeedsName":false,"Name":"String","Url":"String","ClientSecret":"String","PublishableKey":"String","Message":"String","ReopenStep":"String","Customers":[{"ContactId":0,"Name":"String","Phone":"String","BillingMode":"String","AccountCode":"String","Orders":0,"LastOrderAt":"0001-01-01T00:00:00.0000000","Unbilled":0,"UnbilledAmount":0,"Cards":0}],"Run":{"Invoices":0,"Orders":0,"Total":0,"Skipped":["String"]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}