Billhighway Cloud API

<back to all web services

IntegrationPartnerGetRq

The following routes are available for this service:
GET/signup/api/integration/partner/{name}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class IntegrationPartnerGetRq implements IApiRequest
    {
        public String Name = null;
        
        public String getName() { return Name; }
        public IntegrationPartnerGetRq setName(String value) { this.Name = value; return this; }
    }

    public static class IntegrationPartnerRs implements IApiResponse
    {
        public IntegrationPartner Partner = null;
        
        public IntegrationPartner getPartner() { return Partner; }
        public IntegrationPartnerRs setPartner(IntegrationPartner value) { this.Partner = value; return this; }
    }

    public static class IntegrationPartner
    {
        public Integer IntegrationPartnerId = null;
        public String Name = null;
        public String Description = null;
        public String Uri = null;
        public String Username = null;
        public String Password = null;
        public String ApiKey = null;
        public IntegrationPartnerOAuthSettings OAuthSettings = null;
        public ArrayList<IntegrationDestinationConfig> DetinationConfigurations = null;
        public String Scope = null;
        
        public Integer getIntegrationPartnerId() { return IntegrationPartnerId; }
        public IntegrationPartner setIntegrationPartnerId(Integer value) { this.IntegrationPartnerId = value; return this; }
        public String getName() { return Name; }
        public IntegrationPartner setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public IntegrationPartner setDescription(String value) { this.Description = value; return this; }
        public String getUri() { return Uri; }
        public IntegrationPartner setUri(String value) { this.Uri = value; return this; }
        public String getUsername() { return Username; }
        public IntegrationPartner setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public IntegrationPartner setPassword(String value) { this.Password = value; return this; }
        public String getApiKey() { return ApiKey; }
        public IntegrationPartner setApiKey(String value) { this.ApiKey = value; return this; }
        public IntegrationPartnerOAuthSettings getOAuthSettings() { return OAuthSettings; }
        public IntegrationPartner setOAuthSettings(IntegrationPartnerOAuthSettings value) { this.OAuthSettings = value; return this; }
        public ArrayList<IntegrationDestinationConfig> getDetinationConfigurations() { return DetinationConfigurations; }
        public IntegrationPartner setDetinationConfigurations(ArrayList<IntegrationDestinationConfig> value) { this.DetinationConfigurations = value; return this; }
        public String getScope() { return Scope; }
        public IntegrationPartner setScope(String value) { this.Scope = value; return this; }
    }

    public static class IntegrationPartnerOAuthSettings
    {
        public Integer NatId = null;
        public Integer ChapId = null;
        public String AuthorizeUrl = null;
        public String AuthorizeRedirectUri = null;
        public String TokenUrl = null;
        public String UserInfoUrl = null;
        public String ConsumerKey = null;
        public String ConsumerSecret = null;
        public String Username = null;
        public String Password = null;
        public String SecurityToken = null;
        public ArrayList<OAuthAppRedirects> AppRedirects = null;
        
        public Integer getNatId() { return NatId; }
        public IntegrationPartnerOAuthSettings setNatId(Integer value) { this.NatId = value; return this; }
        public Integer getChapId() { return ChapId; }
        public IntegrationPartnerOAuthSettings setChapId(Integer value) { this.ChapId = value; return this; }
        public String getAuthorizeUrl() { return AuthorizeUrl; }
        public IntegrationPartnerOAuthSettings setAuthorizeUrl(String value) { this.AuthorizeUrl = value; return this; }
        public String getAuthorizeRedirectUri() { return AuthorizeRedirectUri; }
        public IntegrationPartnerOAuthSettings setAuthorizeRedirectUri(String value) { this.AuthorizeRedirectUri = value; return this; }
        public String getTokenUrl() { return TokenUrl; }
        public IntegrationPartnerOAuthSettings setTokenUrl(String value) { this.TokenUrl = value; return this; }
        public String getUserInfoUrl() { return UserInfoUrl; }
        public IntegrationPartnerOAuthSettings setUserInfoUrl(String value) { this.UserInfoUrl = value; return this; }
        public String getConsumerKey() { return ConsumerKey; }
        public IntegrationPartnerOAuthSettings setConsumerKey(String value) { this.ConsumerKey = value; return this; }
        public String getConsumerSecret() { return ConsumerSecret; }
        public IntegrationPartnerOAuthSettings setConsumerSecret(String value) { this.ConsumerSecret = value; return this; }
        public String getUsername() { return Username; }
        public IntegrationPartnerOAuthSettings setUsername(String value) { this.Username = value; return this; }
        public String getPassword() { return Password; }
        public IntegrationPartnerOAuthSettings setPassword(String value) { this.Password = value; return this; }
        public String getSecurityToken() { return SecurityToken; }
        public IntegrationPartnerOAuthSettings setSecurityToken(String value) { this.SecurityToken = value; return this; }
        public ArrayList<OAuthAppRedirects> getAppRedirects() { return AppRedirects; }
        public IntegrationPartnerOAuthSettings setAppRedirects(ArrayList<OAuthAppRedirects> value) { this.AppRedirects = value; return this; }
    }

    public static class OAuthAppRedirects
    {
        public String Scope = null;
        public String RedirectTemplate = null;
        public Boolean AllowAnonymous = null;
        
        public String getScope() { return Scope; }
        public OAuthAppRedirects setScope(String value) { this.Scope = value; return this; }
        public String getRedirectTemplate() { return RedirectTemplate; }
        public OAuthAppRedirects setRedirectTemplate(String value) { this.RedirectTemplate = value; return this; }
        public Boolean isAllowAnonymous() { return AllowAnonymous; }
        public OAuthAppRedirects setAllowAnonymous(Boolean value) { this.AllowAnonymous = value; return this; }
    }

    public static class IntegrationDestinationConfig
    {
        public String Type = null;
        public DestinationUriType UriType = null;
        public String Uri = null;
        public String AuthenticationKey = null;
        
        public String getType() { return Type; }
        public IntegrationDestinationConfig setType(String value) { this.Type = value; return this; }
        public DestinationUriType getUriType() { return UriType; }
        public IntegrationDestinationConfig setUriType(DestinationUriType value) { this.UriType = value; return this; }
        public String getUri() { return Uri; }
        public IntegrationDestinationConfig setUri(String value) { this.Uri = value; return this; }
        public String getAuthenticationKey() { return AuthenticationKey; }
        public IntegrationDestinationConfig setAuthenticationKey(String value) { this.AuthenticationKey = value; return this; }
    }

    public static enum DestinationUriType
    {
        @SerializedName("0") None(0),
        @SerializedName("1") Absolute(1),
        @SerializedName("2") Relative(2);

        private final int value;
        DestinationUriType(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java IntegrationPartnerGetRq 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/integration/partner/{name} HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IntegrationPartnerRs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.Partner.Integration.Service">
  <Partner xmlns:d2p1="http://schemas.datacontract.org/2004/07/BH.Partner.Integration">
    <d2p1:_x003C_ApiKey_x003E_k__BackingField>String</d2p1:_x003C_ApiKey_x003E_k__BackingField>
    <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_DetinationConfigurations_x003E_k__BackingField>
      <d2p1:IntegrationDestinationConfig>
        <d2p1:_x003C_AuthenticationKey_x003E_k__BackingField>String</d2p1:_x003C_AuthenticationKey_x003E_k__BackingField>
        <d2p1:_x003C_Type_x003E_k__BackingField>String</d2p1:_x003C_Type_x003E_k__BackingField>
        <d2p1:_x003C_UriType_x003E_k__BackingField>None</d2p1:_x003C_UriType_x003E_k__BackingField>
        <d2p1:_x003C_Uri_x003E_k__BackingField>String</d2p1:_x003C_Uri_x003E_k__BackingField>
      </d2p1:IntegrationDestinationConfig>
    </d2p1:_x003C_DetinationConfigurations_x003E_k__BackingField>
    <d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>0</d2p1:_x003C_IntegrationPartnerId_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
    <d2p1:_x003C_OAuthSettings_x003E_k__BackingField>
      <d2p1:_x003C_AppRedirects_x003E_k__BackingField>
        <d2p1:OAuthAppRedirects>
          <d2p1:_x003C_AllowAnonymous_x003E_k__BackingField>false</d2p1:_x003C_AllowAnonymous_x003E_k__BackingField>
          <d2p1:_x003C_RedirectTemplate_x003E_k__BackingField>String</d2p1:_x003C_RedirectTemplate_x003E_k__BackingField>
          <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
        </d2p1:OAuthAppRedirects>
      </d2p1:_x003C_AppRedirects_x003E_k__BackingField>
      <d2p1:_x003C_AuthorizeRedirectUri_x003E_k__BackingField>String</d2p1:_x003C_AuthorizeRedirectUri_x003E_k__BackingField>
      <d2p1:_x003C_AuthorizeUrl_x003E_k__BackingField>String</d2p1:_x003C_AuthorizeUrl_x003E_k__BackingField>
      <d2p1:_x003C_ChapId_x003E_k__BackingField>0</d2p1:_x003C_ChapId_x003E_k__BackingField>
      <d2p1:_x003C_ConsumerKey_x003E_k__BackingField>String</d2p1:_x003C_ConsumerKey_x003E_k__BackingField>
      <d2p1:_x003C_ConsumerSecret_x003E_k__BackingField>String</d2p1:_x003C_ConsumerSecret_x003E_k__BackingField>
      <d2p1:_x003C_NatId_x003E_k__BackingField>0</d2p1:_x003C_NatId_x003E_k__BackingField>
      <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
      <d2p1:_x003C_SecurityToken_x003E_k__BackingField>String</d2p1:_x003C_SecurityToken_x003E_k__BackingField>
      <d2p1:_x003C_TokenUrl_x003E_k__BackingField>String</d2p1:_x003C_TokenUrl_x003E_k__BackingField>
      <d2p1:_x003C_UserInfoUrl_x003E_k__BackingField>String</d2p1:_x003C_UserInfoUrl_x003E_k__BackingField>
      <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
    </d2p1:_x003C_OAuthSettings_x003E_k__BackingField>
    <d2p1:_x003C_Password_x003E_k__BackingField>String</d2p1:_x003C_Password_x003E_k__BackingField>
    <d2p1:_x003C_Scope_x003E_k__BackingField>String</d2p1:_x003C_Scope_x003E_k__BackingField>
    <d2p1:_x003C_Uri_x003E_k__BackingField>String</d2p1:_x003C_Uri_x003E_k__BackingField>
    <d2p1:_x003C_Username_x003E_k__BackingField>String</d2p1:_x003C_Username_x003E_k__BackingField>
  </Partner>
</IntegrationPartnerRs>