POST Client/GetClientDetail

Gets the client information.

Request Information

URI Parameters

None.

Body Parameters

ApiClientRequestFilter
NameDescriptionTypeAdditional information
clientID

Gets or sets the client identifier.

 integer

None.
userID

Gets or sets the user identifier.

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "clientID": 1,
  "userID": 2
}

application/xml, text/xml

Sample: 
<ApiClientRequestFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <userID>2</userID>
  <clientID>1</clientID>
</ApiClientRequestFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientDetailResponse
NameDescriptionTypeAdditional information
ResponseObject

Gets or sets the response object.

 ApiClientDetail

None.
ResponseType

Gets or sets the type of the response.

 integer

None.
ResponseMessage

Gets or sets the response message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseObject": {
    "ClientID": 1,
    "Email": "sample string 1",
    "CellPhone": "sample string 2",
    "HomePhone": "sample string 3",
    "WorkPhone": "sample string 4",
    "OtherPhone": "sample string 5",
    "Fax": "sample string 6",
    "FK_CountryID": 1,
    "FK_BankID": 1,
    "BankName": "sample string 7",
    "FK_BankBranchID": 1,
    "BankBranchName": "sample string 8",
    "BankAccountNumber": "sample string 9",
    "BankAccountHolder": "sample string 10",
    "BankSBSNumber": "sample string 11",
    "BankSwiftCode": "sample string 12",
    "AgreeToAgePolicy": true,
    "AgreeToTermsAndConditions": true,
    "BankBranchCode": "sample string 13",
    "FK_ClientBankDetailsID": 1,
    "MobileDeviceModel": "sample string 14",
    "MobileIMEI": "sample string 15",
    "MobileManufacter": "sample string 16",
    "PhysicalAddressCity": "sample string 17",
    "PhysicalAddressCode": "sample string 18",
    "PhysicalAddressLineOne": "sample string 19",
    "PhysicalAddressLineTwo": "sample string 20",
    "PhysicalAddressSuburb": "sample string 21",
    "PostalAddressCity": "sample string 22",
    "PostalAddressCode": "sample string 23",
    "PostalAddressLineOne": "sample string 24",
    "PostalAddressLineTwo": "sample string 25",
    "PostalAddressSuburb": "sample string 26",
    "ReceiveNotificationViaEmail": true,
    "ReceivePromotionInfoViaEmail": true,
    "ViewAsFractionalOdds": true,
    "PhysicalAddressFK_RegionID": 1,
    "PostalAddressFK_RegionID": 1,
    "BankingCompliant": true
  },
  "ResponseType": 1,
  "ResponseMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<ApiClientDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponseType>1</ResponseType>
  <ResponseObject>
    <AgreeToAgePolicy>true</AgreeToAgePolicy>
    <AgreeToTermsAndConditions>true</AgreeToTermsAndConditions>
    <BankAccountHolder>sample string 10</BankAccountHolder>
    <BankAccountNumber>sample string 9</BankAccountNumber>
    <BankBranchCode>sample string 13</BankBranchCode>
    <BankBranchName>sample string 8</BankBranchName>
    <BankName>sample string 7</BankName>
    <BankSBSNumber>sample string 11</BankSBSNumber>
    <BankSwiftCode>sample string 12</BankSwiftCode>
    <BankingCompliant>true</BankingCompliant>
    <CellPhone>sample string 2</CellPhone>
    <ClientID>1</ClientID>
    <Email>sample string 1</Email>
    <FK_BankBranchID>1</FK_BankBranchID>
    <FK_BankID>1</FK_BankID>
    <FK_ClientBankDetailsID>1</FK_ClientBankDetailsID>
    <FK_CountryID>1</FK_CountryID>
    <Fax>sample string 6</Fax>
    <HomePhone>sample string 3</HomePhone>
    <MobileDeviceModel>sample string 14</MobileDeviceModel>
    <MobileIMEI>sample string 15</MobileIMEI>
    <MobileManufacter>sample string 16</MobileManufacter>
    <OtherPhone>sample string 5</OtherPhone>
    <PhysicalAddressCity>sample string 17</PhysicalAddressCity>
    <PhysicalAddressCode>sample string 18</PhysicalAddressCode>
    <PhysicalAddressFK_RegionID>1</PhysicalAddressFK_RegionID>
    <PhysicalAddressLineOne>sample string 19</PhysicalAddressLineOne>
    <PhysicalAddressLineTwo>sample string 20</PhysicalAddressLineTwo>
    <PhysicalAddressSuburb>sample string 21</PhysicalAddressSuburb>
    <PostalAddressCity>sample string 22</PostalAddressCity>
    <PostalAddressCode>sample string 23</PostalAddressCode>
    <PostalAddressFK_RegionID>1</PostalAddressFK_RegionID>
    <PostalAddressLineOne>sample string 24</PostalAddressLineOne>
    <PostalAddressLineTwo>sample string 25</PostalAddressLineTwo>
    <PostalAddressSuburb>sample string 26</PostalAddressSuburb>
    <ReceiveNotificationViaEmail>true</ReceiveNotificationViaEmail>
    <ReceivePromotionInfoViaEmail>true</ReceivePromotionInfoViaEmail>
    <ViewAsFractionalOdds>true</ViewAsFractionalOdds>
    <WorkPhone>sample string 4</WorkPhone>
  </ResponseObject>
</ApiClientDetailResponse>