| GET | /signup/api/integration/partner/{name} |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OAuthAppRedirects:
scope: Optional[str] = None
redirect_template: Optional[str] = None
allow_anonymous: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationPartnerOAuthSettings:
nat_id: Optional[int] = None
chap_id: Optional[int] = None
authorize_url: Optional[str] = None
authorize_redirect_uri: Optional[str] = None
token_url: Optional[str] = None
user_info_url: Optional[str] = None
consumer_key: Optional[str] = None
consumer_secret: Optional[str] = None
username: Optional[str] = None
password: Optional[str] = None
security_token: Optional[str] = None
app_redirects: Optional[List[OAuthAppRedirects]] = None
class DestinationUriType(IntEnum):
NONE = 0
ABSOLUTE = 1
RELATIVE = 2
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationDestinationConfig:
type: Optional[str] = None
uri_type: Optional[DestinationUriType] = None
uri: Optional[str] = None
authentication_key: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationPartner:
integration_partner_id: Optional[int] = None
name: Optional[str] = None
description: Optional[str] = None
uri: Optional[str] = None
username: Optional[str] = None
password: Optional[str] = None
api_key: Optional[str] = None
o_auth_settings: Optional[IntegrationPartnerOAuthSettings] = None
detination_configurations: Optional[List[IntegrationDestinationConfig]] = None
scope: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationPartnerRs(IApiResponse):
partner: Optional[IntegrationPartner] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class IntegrationPartnerGetRq(IApiRequest):
name: Optional[str] = None
Python IntegrationPartnerGetRq DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>