POST api/Retailer/Invitation

Generate new loan application invitation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerEmail	string	Max length: 100
RetailersReference	string	None.
RateCardProductId	globally unique identifier	None.
Price	decimal number	None.
Deposit	decimal number	None.
DescriptionOfGoods	string	None.
EmailInvitation	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerEmail": "sample string 1",
  "RetailersReference": "sample string 2",
  "RateCardProductId": "01357e1a-2a01-42b2-9510-0159f13b54e4",
  "Price": 1.0,
  "Deposit": 1.0,
  "DescriptionOfGoods": "sample string 3",
  "EmailInvitation": true
}

text/html

Sample:

{"CustomerEmail":"sample string 1","RetailersReference":"sample string 2","RateCardProductId":"01357e1a-2a01-42b2-9510-0159f13b54e4","Price":1.0,"Deposit":1.0,"DescriptionOfGoods":"sample string 3","EmailInvitation":true}

application/xml, text/xml

Sample:

<InvitationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.InvitationRequestModels">
  <CustomerEmail>sample string 1</CustomerEmail>
  <Deposit>1</Deposit>
  <DescriptionOfGoods>sample string 3</DescriptionOfGoods>
  <EmailInvitation>true</EmailInvitation>
  <Price>1</Price>
  <RateCardProductId>01357e1a-2a01-42b2-9510-0159f13b54e4</RateCardProductId>
  <RetailersReference>sample string 2</RetailersReference>
</InvitationRequestModel>

Response Information

Resource Description

Returns the invitation id and the URL to initiate application.

InvitationResponseModel

Name	Type	Additional information
InvitationId	globally unique identifier	None.
Url	string	None.
Info	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InvitationId": "77fee6ab-8b20-43ff-8fc4-f72fe77784c1",
  "Url": "sample string 2",
  "Info": "sample string 3"
}

text/html

Sample:

{"InvitationId":"77fee6ab-8b20-43ff-8fc4-f72fe77784c1","Url":"sample string 2","Info":"sample string 3"}

application/xml, text/xml

Sample:

<InvitationResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.InvitationResponses">
  <Info>sample string 3</Info>
  <InvitationId>77fee6ab-8b20-43ff-8fc4-f72fe77784c1</InvitationId>
  <Url>sample string 2</Url>
</InvitationResponseModel>