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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.StandardSignupForm.Request;
using BH.CloudAPI.Common4.DTO.StandardSignupForm.Response;
using BH.API.DataAccess.Dto;

namespace BH.API.DataAccess.Dto
{
    public partial class ContextualHelpDto
    {
        public virtual string ControlName { get; set; }
        public virtual string LabelText { get; set; }
        public virtual bool IsVisible { get; set; }
        public virtual bool IsRequired { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Request
{
    public partial class StandardSignupFormChapterContextualHelpRq
        : IApiRequest
    {
        public virtual string NatId { get; set; }
        public virtual string ChapId { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.StandardSignupForm.Response
{
    public partial class StandardSignupFormChapterContextualHelpRs
        : IApiResponse
    {
        public StandardSignupFormChapterContextualHelpRs()
        {
            ContextualHelpList = new List<ContextualHelpDto>{};
        }

        public virtual List<ContextualHelpDto> ContextualHelpList { get; set; }
    }

}

C# 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>