Billhighway Cloud API

IntegrationPartnerGetRq

The following routes are available for this service:
GET	/signup/api/integration/partner/{name}


export class OAuthAppRedirects
{
    public Scope?: string;
    public RedirectTemplate?: string;
    public AllowAnonymous?: boolean;

    public constructor(init?: Partial<OAuthAppRedirects>) { (Object as any).assign(this, init); }
}

export class IntegrationPartnerOAuthSettings
{
    public NatId?: number;
    public ChapId?: number;
    public AuthorizeUrl?: string;
    public AuthorizeRedirectUri?: string;
    public TokenUrl?: string;
    public UserInfoUrl?: string;
    public ConsumerKey?: string;
    public ConsumerSecret?: string;
    public Username?: string;
    public Password?: string;
    public SecurityToken?: string;
    public AppRedirects?: OAuthAppRedirects[];

    public constructor(init?: Partial<IntegrationPartnerOAuthSettings>) { (Object as any).assign(this, init); }
}

export enum DestinationUriType
{
    None = 0,
    Absolute = 1,
    Relative = 2,
}

export class IntegrationDestinationConfig
{
    public Type?: string;
    public UriType?: DestinationUriType;
    public Uri?: string;
    public AuthenticationKey?: string;

    public constructor(init?: Partial<IntegrationDestinationConfig>) { (Object as any).assign(this, init); }
}

export class IntegrationPartner
{
    public IntegrationPartnerId?: number;
    public Name?: string;
    public Description?: string;
    public Uri?: string;
    public Username?: string;
    public Password?: string;
    public ApiKey?: string;
    public OAuthSettings?: IntegrationPartnerOAuthSettings;
    public DetinationConfigurations?: IntegrationDestinationConfig[];
    public Scope?: string;

    public constructor(init?: Partial<IntegrationPartner>) { (Object as any).assign(this, init); }
}

export class IntegrationPartnerRs implements IApiResponse
{
    public Partner?: IntegrationPartner;

    public constructor(init?: Partial<IntegrationPartnerRs>) { (Object as any).assign(this, init); }
}

export class IntegrationPartnerGetRq implements IApiRequest
{
    public Name?: string;

    public constructor(init?: Partial<IntegrationPartnerGetRq>) { (Object as any).assign(this, init); }
}

TypeScript IntegrationPartnerGetRq DTOs

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

HTTP + CSV

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: text/csv

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

{"Partner":{"IntegrationPartnerId":0,"Name":"String","Description":"String","Uri":"String","Username":"String","Password":"String","ApiKey":"String","OAuthSettings":{"NatId":0,"ChapId":0,"AuthorizeUrl":"String","AuthorizeRedirectUri":"String","TokenUrl":"String","UserInfoUrl":"String","ConsumerKey":"String","ConsumerSecret":"String","Username":"String","Password":"String","SecurityToken":"String","AppRedirects":[{"Scope":"String","RedirectTemplate":"String","AllowAnonymous":false}]},"DetinationConfigurations":[{"Type":"String","UriType":0,"Uri":"String","AuthenticationKey":"String"}],"Scope":"String"}}