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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class StandardSignupFormChapterContextualHelpRq implements IApiRequest
    {
        public String NatId = null;
        public String ChapId = null;
        
        public String getNatId() { return NatId; }
        public StandardSignupFormChapterContextualHelpRq setNatId(String value) { this.NatId = value; return this; }
        public String getChapId() { return ChapId; }
        public StandardSignupFormChapterContextualHelpRq setChapId(String value) { this.ChapId = value; return this; }
    }

    public static class StandardSignupFormChapterContextualHelpRs implements IApiResponse
    {
        public ArrayList<ContextualHelpDto> ContextualHelpList = null;
        
        public ArrayList<ContextualHelpDto> getContextualHelpList() { return ContextualHelpList; }
        public StandardSignupFormChapterContextualHelpRs setContextualHelpList(ArrayList<ContextualHelpDto> value) { this.ContextualHelpList = value; return this; }
    }

    public static class ContextualHelpDto
    {
        public String ControlName = null;
        public String LabelText = null;
        public Boolean IsVisible = null;
        public Boolean IsRequired = null;
        
        public String getControlName() { return ControlName; }
        public ContextualHelpDto setControlName(String value) { this.ControlName = value; return this; }
        public String getLabelText() { return LabelText; }
        public ContextualHelpDto setLabelText(String value) { this.LabelText = value; return this; }
        public Boolean getIsVisible() { return IsVisible; }
        public ContextualHelpDto setIsVisible(Boolean value) { this.IsVisible = value; return this; }
        public Boolean getIsRequired() { return IsRequired; }
        public ContextualHelpDto setIsRequired(Boolean value) { this.IsRequired = value; return this; }
    }

}

Java 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>