GET api/Introducer/CreditCheck/InitialData

Get initial data. Available for introducer users

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Json containing all predefined fields.

IntroducerInitialDataResponse

Name	Type	Additional information
Retailers	Collection of IntroducerRetailerModel	None.
Titles	Collection of Pair of string [key] and string [value]	None.
Genders	Collection of Pair of string [key] and string [value]	None.
MaritalStatuses	Collection of Pair of string [key] and string [value]	None.
ResidentialStatuses	Collection of Pair of string [key] and string [value]	None.
YearsAtAddress	Collection of Pair of string [key] and string [value]	None.
EmploymentStatuses	Collection of Pair of string [key] and string [value]	None.
YearsSelfEmployed	Collection of Pair of string [key] and string [value]	None.
YearsWithEmployer	Collection of Pair of string [key] and string [value]	None.
SourcesOfIncome	Collection of Pair of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "Retailers": [
    {
      "Retailer": "sample string 1",
      "RetailerId": "3a11f145-d9af-4e92-a04e-2fc46c978dfe",
      "OnlineRateCardProducts": [
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        },
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        }
      ],
      "InStoreRateCardProducts": [
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        },
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        }
      ],
      "RetailerBranches": [
        {
          "RetailerBranchId": "66f8d16a-186a-4cb9-952c-167ba64a698e",
          "RetailerBranchName": "sample string 2",
          "BranchType": "sample string 3"
        },
        {
          "RetailerBranchId": "66f8d16a-186a-4cb9-952c-167ba64a698e",
          "RetailerBranchName": "sample string 2",
          "BranchType": "sample string 3"
        }
      ]
    },
    {
      "Retailer": "sample string 1",
      "RetailerId": "3a11f145-d9af-4e92-a04e-2fc46c978dfe",
      "OnlineRateCardProducts": [
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        },
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        }
      ],
      "InStoreRateCardProducts": [
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        },
        {
          "RateCardProductName": "sample string 1",
          "RateCardProductId": "51a13f68-df1a-4a52-8616-c7a30de24d5e",
          "CommissionConsentRequired": "sample string 3"
        }
      ],
      "RetailerBranches": [
        {
          "RetailerBranchId": "66f8d16a-186a-4cb9-952c-167ba64a698e",
          "RetailerBranchName": "sample string 2",
          "BranchType": "sample string 3"
        },
        {
          "RetailerBranchId": "66f8d16a-186a-4cb9-952c-167ba64a698e",
          "RetailerBranchName": "sample string 2",
          "BranchType": "sample string 3"
        }
      ]
    }
  ],
  "Titles": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "Genders": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "MaritalStatuses": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "ResidentialStatuses": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "YearsAtAddress": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "EmploymentStatuses": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "YearsSelfEmployed": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "YearsWithEmployer": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "SourcesOfIncome": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

text/html

Sample:

{"Retailers":[{"Retailer":"sample string 1","RetailerId":"3a11f145-d9af-4e92-a04e-2fc46c978dfe","OnlineRateCardProducts":[{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"},{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"}],"InStoreRateCardProducts":[{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"},{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"}],"RetailerBranches":[{"RetailerBranchId":"66f8d16a-186a-4cb9-952c-167ba64a698e","RetailerBranchName":"sample string 2","BranchType":"sample string 3"},{"RetailerBranchId":"66f8d16a-186a-4cb9-952c-167ba64a698e","RetailerBranchName":"sample string 2","BranchType":"sample string 3"}]},{"Retailer":"sample string 1","RetailerId":"3a11f145-d9af-4e92-a04e-2fc46c978dfe","OnlineRateCardProducts":[{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"},{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"}],"InStoreRateCardProducts":[{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"},{"RateCardProductName":"sample string 1","RateCardProductId":"51a13f68-df1a-4a52-8616-c7a30de24d5e","CommissionConsentRequired":"sample string 3"}],"RetailerBranches":[{"RetailerBranchId":"66f8d16a-186a-4cb9-952c-167ba64a698e","RetailerBranchName":"sample string 2","BranchType":"sample string 3"},{"RetailerBranchId":"66f8d16a-186a-4cb9-952c-167ba64a698e","RetailerBranchName":"sample string 2","BranchType":"sample string 3"}]}],"Titles":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"Genders":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"MaritalStatuses":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"ResidentialStatuses":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"YearsAtAddress":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"EmploymentStatuses":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"YearsSelfEmployed":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"YearsWithEmployer":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}],"SourcesOfIncome":[{"Key":"sample string 1","Value":"sample string 2"},{"Key":"sample string 1","Value":"sample string 2"}]}

application/xml, text/xml

Sample:

<IntroducerInitialDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.IntroducerResponses">
  <EmploymentStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </EmploymentStatuses>
  <Genders xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Genders>
  <MaritalStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </MaritalStatuses>
  <ResidentialStatuses xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </ResidentialStatuses>
  <SourcesOfIncome xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </SourcesOfIncome>
  <Titles xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Titles>
  <YearsAtAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </YearsAtAddress>
  <YearsSelfEmployed xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </YearsSelfEmployed>
  <YearsWithEmployer xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </YearsWithEmployer>
  <Retailers>
    <IntroducerRetailerModel>
      <InStoreRateCardProducts>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
      </InStoreRateCardProducts>
      <OnlineRateCardProducts>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
      </OnlineRateCardProducts>
      <Retailer>sample string 1</Retailer>
      <RetailerBranches>
        <RetailerBranchModel>
          <BranchType>sample string 3</BranchType>
          <RetailerBranchId>66f8d16a-186a-4cb9-952c-167ba64a698e</RetailerBranchId>
          <RetailerBranchName>sample string 2</RetailerBranchName>
        </RetailerBranchModel>
        <RetailerBranchModel>
          <BranchType>sample string 3</BranchType>
          <RetailerBranchId>66f8d16a-186a-4cb9-952c-167ba64a698e</RetailerBranchId>
          <RetailerBranchName>sample string 2</RetailerBranchName>
        </RetailerBranchModel>
      </RetailerBranches>
      <RetailerId>3a11f145-d9af-4e92-a04e-2fc46c978dfe</RetailerId>
    </IntroducerRetailerModel>
    <IntroducerRetailerModel>
      <InStoreRateCardProducts>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
      </InStoreRateCardProducts>
      <OnlineRateCardProducts>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
        <RateCardProductModel>
          <CommissionConsentRequired>sample string 3</CommissionConsentRequired>
          <RateCardProductId>51a13f68-df1a-4a52-8616-c7a30de24d5e</RateCardProductId>
          <RateCardProductName>sample string 1</RateCardProductName>
        </RateCardProductModel>
      </OnlineRateCardProducts>
      <Retailer>sample string 1</Retailer>
      <RetailerBranches>
        <RetailerBranchModel>
          <BranchType>sample string 3</BranchType>
          <RetailerBranchId>66f8d16a-186a-4cb9-952c-167ba64a698e</RetailerBranchId>
          <RetailerBranchName>sample string 2</RetailerBranchName>
        </RetailerBranchModel>
        <RetailerBranchModel>
          <BranchType>sample string 3</BranchType>
          <RetailerBranchId>66f8d16a-186a-4cb9-952c-167ba64a698e</RetailerBranchId>
          <RetailerBranchName>sample string 2</RetailerBranchName>
        </RetailerBranchModel>
      </RetailerBranches>
      <RetailerId>3a11f145-d9af-4e92-a04e-2fc46c978dfe</RetailerId>
    </IntroducerRetailerModel>
  </Retailers>
</IntroducerInitialDataResponse>