Billhighway Cloud API

<back to all web services

StandardSignupFormChapterContextualHelpRq

The following routes are available for this service:
GET/signup/api/nat/{natID}/chap/{chapID}/standardSignup/contextualHelp
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.StandardSignupForm.Request
Imports BH.CloudAPI.Common4.DTO.StandardSignupForm.Response
Imports BH.API.DataAccess.Dto

Namespace Global

    Namespace BH.API.DataAccess.Dto

        Public Partial Class ContextualHelpDto
            Public Overridable Property ControlName As String
            Public Overridable Property LabelText As String
            Public Overridable Property IsVisible As Boolean
            Public Overridable Property IsRequired As Boolean
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Request

        Public Partial Class StandardSignupFormChapterContextualHelpRq
            Implements IApiRequest
            Public Overridable Property NatId As String
            Public Overridable Property ChapId As String
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Response

        Public Partial Class StandardSignupFormChapterContextualHelpRs
            Implements IApiResponse
            Public Sub New()
                ContextualHelpList = New List(Of ContextualHelpDto)
            End Sub

            Public Overridable Property ContextualHelpList As List(Of ContextualHelpDto)
        End Class
    End Namespace
End Namespace

VB.NET StandardSignupFormChapterContextualHelpRq DTOs

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

HTTP + XML

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

GET /signup/api/nat/{natID}/chap/{chapID}/standardSignup/contextualHelp HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StandardSignupFormChapterContextualHelpRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.StandardSignupForm.Response">
  <ContextualHelpList xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.API.DataAccess.Dto">
    <d2p1:ContextualHelpDto>
      <d2p1:ControlName>String</d2p1:ControlName>
      <d2p1:IsRequired>false</d2p1:IsRequired>
      <d2p1:IsVisible>false</d2p1:IsVisible>
      <d2p1:LabelText>String</d2p1:LabelText>
    </d2p1:ContextualHelpDto>
  </ContextualHelpList>
</StandardSignupFormChapterContextualHelpRs>