POST api/BankiomCommunity/SendInvites

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ContactId	globally unique identifier	None.
UserId	globally unique identifier	None.
InvitedUserId	globally unique identifier	None.
ContactName	string	None.
ContactNumber	string	None.
ContactDateTime	date	None.
ProfileImageName	string	None.
IsRegistered	boolean	None.
IsFavourite	boolean	None.
InviteResponse	InviteResponse	None.
AllowanceViewModel	AllowanceViewModel	None.
OneTimerPaymentAllowanceDetails	Collection of AllowanceViewModel	None.
IsCardExist	boolean	None.
IsMyChild	boolean	None.
UserInviteType	CommunityUserDetailType	None.

Request Formats

application/json, text/json

Sample:

{
  "ContactId": "006a540a-eefd-4762-b764-15083c073103",
  "UserId": "10314df8-ab18-4d98-ac31-4c6c3dc7b002",
  "InvitedUserId": "80c8dfed-4f01-41f1-818d-d653c98359b0",
  "ContactName": "sample string 3",
  "ContactNumber": "sample string 4",
  "ContactDateTime": "2023-12-05T12:06:10.5026121+00:00",
  "ProfileImageName": "sample string 6",
  "IsRegistered": true,
  "IsFavourite": true,
  "InviteResponse": 0,
  "AllowanceViewModel": {
    "AllowanceId": "e6edcb6c-aa0c-4c2d-bd7c-eded53ffb6ff",
    "SenderUserId": "1361afa5-b056-40f0-86a8-72ea90a6eea5",
    "ReceiverUserId": "e0276e32-351a-453a-83af-425f7a87a8ad",
    "SenderCardId": "6fb37cd8-314a-43dd-861d-1106733e0af0",
    "ReceiverCardId": "eaa50a9d-e510-4156-a24f-c0850aa4a64b",
    "ReceiverFirstName": "sample string 5",
    "ReceiverLastName": "sample string 6",
    "ReceiverProfile": "sample string 7",
    "ReceiverMobile": "sample string 8",
    "AllowanceName": "sample string 9",
    "AllowanceDateTime": "2023-12-05T12:06:10.5026121+00:00",
    "IsEnabled": true,
    "Hours": 12,
    "AllowanceTypeId": "aa4a2d2f-1d9a-443a-8a62-529459c2ff91",
    "AllowancePatternId": "442eb26e-6cea-4ff2-8ba6-a0386af217b6",
    "AllowanceAmount": 15.1,
    "AllowanceCurrency": "sample string 16",
    "AllowancePatternName": "sample string 17",
    "AllowanceTypeDetails": {
      "AllowanceTypeId": "8133143f-a2ff-4364-aafc-f00baaa8ba10",
      "AllowanceTypeName": "sample string 2",
      "Sequence": 3
    },
    "AllowancePatternDetails": {
      "AllowancePatternId": "2ee66bd5-66af-42e3-b1df-da447c4991c1",
      "PatternName": "sample string 2",
      "AllowanceTypeId": "75e64353-16d6-4e7c-a13f-7084b9d7a0a4",
      "Sequence": 4,
      "PatternNumber": 5
    },
    "Type": 0,
    "Message": "sample string 18",
    "PaymentScheduleDateString": "sample string 19",
    "PaymentScheduleDate": "2023-12-05T12:06:10.5026121+00:00",
    "PaymentImage": "sample string 21",
    "NoOfAllowance": 22,
    "AllowanceStartDateString": "sample string 23",
    "AllowanceEndDateString": "sample string 24",
    "FirstPaymentDateString": "sample string 25",
    "FirstPaymentDate": "2023-12-05T12:06:10.5026121+00:00",
    "AllowanceStartDate": "2023-12-05T12:06:10.5026121+00:00",
    "AllowanceEndDate": "2023-12-05T12:06:10.5026121+00:00"
  },
  "OneTimerPaymentAllowanceDetails": [
    {
      "AllowanceId": "e6edcb6c-aa0c-4c2d-bd7c-eded53ffb6ff",
      "SenderUserId": "1361afa5-b056-40f0-86a8-72ea90a6eea5",
      "ReceiverUserId": "e0276e32-351a-453a-83af-425f7a87a8ad",
      "SenderCardId": "6fb37cd8-314a-43dd-861d-1106733e0af0",
      "ReceiverCardId": "eaa50a9d-e510-4156-a24f-c0850aa4a64b",
      "ReceiverFirstName": "sample string 5",
      "ReceiverLastName": "sample string 6",
      "ReceiverProfile": "sample string 7",
      "ReceiverMobile": "sample string 8",
      "AllowanceName": "sample string 9",
      "AllowanceDateTime": "2023-12-05T12:06:10.5026121+00:00",
      "IsEnabled": true,
      "Hours": 12,
      "AllowanceTypeId": "aa4a2d2f-1d9a-443a-8a62-529459c2ff91",
      "AllowancePatternId": "442eb26e-6cea-4ff2-8ba6-a0386af217b6",
      "AllowanceAmount": 15.1,
      "AllowanceCurrency": "sample string 16",
      "AllowancePatternName": "sample string 17",
      "AllowanceTypeDetails": {
        "AllowanceTypeId": "8133143f-a2ff-4364-aafc-f00baaa8ba10",
        "AllowanceTypeName": "sample string 2",
        "Sequence": 3
      },
      "AllowancePatternDetails": {
        "AllowancePatternId": "2ee66bd5-66af-42e3-b1df-da447c4991c1",
        "PatternName": "sample string 2",
        "AllowanceTypeId": "75e64353-16d6-4e7c-a13f-7084b9d7a0a4",
        "Sequence": 4,
        "PatternNumber": 5
      },
      "Type": 0,
      "Message": "sample string 18",
      "PaymentScheduleDateString": "sample string 19",
      "PaymentScheduleDate": "2023-12-05T12:06:10.5026121+00:00",
      "PaymentImage": "sample string 21",
      "NoOfAllowance": 22,
      "AllowanceStartDateString": "sample string 23",
      "AllowanceEndDateString": "sample string 24",
      "FirstPaymentDateString": "sample string 25",
      "FirstPaymentDate": "2023-12-05T12:06:10.5026121+00:00",
      "AllowanceStartDate": "2023-12-05T12:06:10.5026121+00:00",
      "AllowanceEndDate": "2023-12-05T12:06:10.5026121+00:00"
    },
    {
      "AllowanceId": "e6edcb6c-aa0c-4c2d-bd7c-eded53ffb6ff",
      "SenderUserId": "1361afa5-b056-40f0-86a8-72ea90a6eea5",
      "ReceiverUserId": "e0276e32-351a-453a-83af-425f7a87a8ad",
      "SenderCardId": "6fb37cd8-314a-43dd-861d-1106733e0af0",
      "ReceiverCardId": "eaa50a9d-e510-4156-a24f-c0850aa4a64b",
      "ReceiverFirstName": "sample string 5",
      "ReceiverLastName": "sample string 6",
      "ReceiverProfile": "sample string 7",
      "ReceiverMobile": "sample string 8",
      "AllowanceName": "sample string 9",
      "AllowanceDateTime": "2023-12-05T12:06:10.5026121+00:00",
      "IsEnabled": true,
      "Hours": 12,
      "AllowanceTypeId": "aa4a2d2f-1d9a-443a-8a62-529459c2ff91",
      "AllowancePatternId": "442eb26e-6cea-4ff2-8ba6-a0386af217b6",
      "AllowanceAmount": 15.1,
      "AllowanceCurrency": "sample string 16",
      "AllowancePatternName": "sample string 17",
      "AllowanceTypeDetails": {
        "AllowanceTypeId": "8133143f-a2ff-4364-aafc-f00baaa8ba10",
        "AllowanceTypeName": "sample string 2",
        "Sequence": 3
      },
      "AllowancePatternDetails": {
        "AllowancePatternId": "2ee66bd5-66af-42e3-b1df-da447c4991c1",
        "PatternName": "sample string 2",
        "AllowanceTypeId": "75e64353-16d6-4e7c-a13f-7084b9d7a0a4",
        "Sequence": 4,
        "PatternNumber": 5
      },
      "Type": 0,
      "Message": "sample string 18",
      "PaymentScheduleDateString": "sample string 19",
      "PaymentScheduleDate": "2023-12-05T12:06:10.5026121+00:00",
      "PaymentImage": "sample string 21",
      "NoOfAllowance": 22,
      "AllowanceStartDateString": "sample string 23",
      "AllowanceEndDateString": "sample string 24",
      "FirstPaymentDateString": "sample string 25",
      "FirstPaymentDate": "2023-12-05T12:06:10.5026121+00:00",
      "AllowanceStartDate": "2023-12-05T12:06:10.5026121+00:00",
      "AllowanceEndDate": "2023-12-05T12:06:10.5026121+00:00"
    }
  ],
  "IsCardExist": true,
  "IsMyChild": true,
  "UserInviteType": 0
}

application/xml, text/xml

Sample:

<PendingInviteViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <AllowanceViewModel>
    <AllowanceAmount>15.1</AllowanceAmount>
    <AllowanceCurrency>sample string 16</AllowanceCurrency>
    <AllowanceDateTime>2023-12-05T12:06:10.5026121+00:00</AllowanceDateTime>
    <AllowanceEndDate>2023-12-05T12:06:10.5026121+00:00</AllowanceEndDate>
    <AllowanceEndDateString>sample string 24</AllowanceEndDateString>
    <AllowanceId>e6edcb6c-aa0c-4c2d-bd7c-eded53ffb6ff</AllowanceId>
    <AllowanceName>sample string 9</AllowanceName>
    <AllowancePatternDetails>
      <AllowancePatternId>2ee66bd5-66af-42e3-b1df-da447c4991c1</AllowancePatternId>
      <AllowanceTypeId>75e64353-16d6-4e7c-a13f-7084b9d7a0a4</AllowanceTypeId>
      <PatternName>sample string 2</PatternName>
      <PatternNumber>5</PatternNumber>
      <Sequence>4</Sequence>
    </AllowancePatternDetails>
    <AllowancePatternId>442eb26e-6cea-4ff2-8ba6-a0386af217b6</AllowancePatternId>
    <AllowancePatternName>sample string 17</AllowancePatternName>
    <AllowanceStartDate>2023-12-05T12:06:10.5026121+00:00</AllowanceStartDate>
    <AllowanceStartDateString>sample string 23</AllowanceStartDateString>
    <AllowanceTypeDetails>
      <AllowanceTypeId>8133143f-a2ff-4364-aafc-f00baaa8ba10</AllowanceTypeId>
      <AllowanceTypeName>sample string 2</AllowanceTypeName>
      <Sequence>3</Sequence>
    </AllowanceTypeDetails>
    <AllowanceTypeId>aa4a2d2f-1d9a-443a-8a62-529459c2ff91</AllowanceTypeId>
    <FirstPaymentDate>2023-12-05T12:06:10.5026121+00:00</FirstPaymentDate>
    <FirstPaymentDateString>sample string 25</FirstPaymentDateString>
    <Hours>12</Hours>
    <IsEnabled>true</IsEnabled>
    <Message>sample string 18</Message>
    <NoOfAllowance>22</NoOfAllowance>
    <PaymentImage>sample string 21</PaymentImage>
    <PaymentScheduleDate>2023-12-05T12:06:10.5026121+00:00</PaymentScheduleDate>
    <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString>
    <ReceiverCardId>eaa50a9d-e510-4156-a24f-c0850aa4a64b</ReceiverCardId>
    <ReceiverFirstName>sample string 5</ReceiverFirstName>
    <ReceiverLastName>sample string 6</ReceiverLastName>
    <ReceiverMobile>sample string 8</ReceiverMobile>
    <ReceiverProfile>sample string 7</ReceiverProfile>
    <ReceiverUserId>e0276e32-351a-453a-83af-425f7a87a8ad</ReceiverUserId>
    <SenderCardId>6fb37cd8-314a-43dd-861d-1106733e0af0</SenderCardId>
    <SenderUserId>1361afa5-b056-40f0-86a8-72ea90a6eea5</SenderUserId>
    <Type>Default</Type>
  </AllowanceViewModel>
  <ContactDateTime>2023-12-05T12:06:10.5026121+00:00</ContactDateTime>
  <ContactId>006a540a-eefd-4762-b764-15083c073103</ContactId>
  <ContactName>sample string 3</ContactName>
  <ContactNumber>sample string 4</ContactNumber>
  <InviteResponse>Default</InviteResponse>
  <InvitedUserId>80c8dfed-4f01-41f1-818d-d653c98359b0</InvitedUserId>
  <IsCardExist>true</IsCardExist>
  <IsFavourite>true</IsFavourite>
  <IsMyChild>true</IsMyChild>
  <IsRegistered>true</IsRegistered>
  <OneTimerPaymentAllowanceDetails>
    <AllowanceViewModel>
      <AllowanceAmount>15.1</AllowanceAmount>
      <AllowanceCurrency>sample string 16</AllowanceCurrency>
      <AllowanceDateTime>2023-12-05T12:06:10.5026121+00:00</AllowanceDateTime>
      <AllowanceEndDate>2023-12-05T12:06:10.5026121+00:00</AllowanceEndDate>
      <AllowanceEndDateString>sample string 24</AllowanceEndDateString>
      <AllowanceId>e6edcb6c-aa0c-4c2d-bd7c-eded53ffb6ff</AllowanceId>
      <AllowanceName>sample string 9</AllowanceName>
      <AllowancePatternDetails>
        <AllowancePatternId>2ee66bd5-66af-42e3-b1df-da447c4991c1</AllowancePatternId>
        <AllowanceTypeId>75e64353-16d6-4e7c-a13f-7084b9d7a0a4</AllowanceTypeId>
        <PatternName>sample string 2</PatternName>
        <PatternNumber>5</PatternNumber>
        <Sequence>4</Sequence>
      </AllowancePatternDetails>
      <AllowancePatternId>442eb26e-6cea-4ff2-8ba6-a0386af217b6</AllowancePatternId>
      <AllowancePatternName>sample string 17</AllowancePatternName>
      <AllowanceStartDate>2023-12-05T12:06:10.5026121+00:00</AllowanceStartDate>
      <AllowanceStartDateString>sample string 23</AllowanceStartDateString>
      <AllowanceTypeDetails>
        <AllowanceTypeId>8133143f-a2ff-4364-aafc-f00baaa8ba10</AllowanceTypeId>
        <AllowanceTypeName>sample string 2</AllowanceTypeName>
        <Sequence>3</Sequence>
      </AllowanceTypeDetails>
      <AllowanceTypeId>aa4a2d2f-1d9a-443a-8a62-529459c2ff91</AllowanceTypeId>
      <FirstPaymentDate>2023-12-05T12:06:10.5026121+00:00</FirstPaymentDate>
      <FirstPaymentDateString>sample string 25</FirstPaymentDateString>
      <Hours>12</Hours>
      <IsEnabled>true</IsEnabled>
      <Message>sample string 18</Message>
      <NoOfAllowance>22</NoOfAllowance>
      <PaymentImage>sample string 21</PaymentImage>
      <PaymentScheduleDate>2023-12-05T12:06:10.5026121+00:00</PaymentScheduleDate>
      <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString>
      <ReceiverCardId>eaa50a9d-e510-4156-a24f-c0850aa4a64b</ReceiverCardId>
      <ReceiverFirstName>sample string 5</ReceiverFirstName>
      <ReceiverLastName>sample string 6</ReceiverLastName>
      <ReceiverMobile>sample string 8</ReceiverMobile>
      <ReceiverProfile>sample string 7</ReceiverProfile>
      <ReceiverUserId>e0276e32-351a-453a-83af-425f7a87a8ad</ReceiverUserId>
      <SenderCardId>6fb37cd8-314a-43dd-861d-1106733e0af0</SenderCardId>
      <SenderUserId>1361afa5-b056-40f0-86a8-72ea90a6eea5</SenderUserId>
      <Type>Default</Type>
    </AllowanceViewModel>
    <AllowanceViewModel>
      <AllowanceAmount>15.1</AllowanceAmount>
      <AllowanceCurrency>sample string 16</AllowanceCurrency>
      <AllowanceDateTime>2023-12-05T12:06:10.5026121+00:00</AllowanceDateTime>
      <AllowanceEndDate>2023-12-05T12:06:10.5026121+00:00</AllowanceEndDate>
      <AllowanceEndDateString>sample string 24</AllowanceEndDateString>
      <AllowanceId>e6edcb6c-aa0c-4c2d-bd7c-eded53ffb6ff</AllowanceId>
      <AllowanceName>sample string 9</AllowanceName>
      <AllowancePatternDetails>
        <AllowancePatternId>2ee66bd5-66af-42e3-b1df-da447c4991c1</AllowancePatternId>
        <AllowanceTypeId>75e64353-16d6-4e7c-a13f-7084b9d7a0a4</AllowanceTypeId>
        <PatternName>sample string 2</PatternName>
        <PatternNumber>5</PatternNumber>
        <Sequence>4</Sequence>
      </AllowancePatternDetails>
      <AllowancePatternId>442eb26e-6cea-4ff2-8ba6-a0386af217b6</AllowancePatternId>
      <AllowancePatternName>sample string 17</AllowancePatternName>
      <AllowanceStartDate>2023-12-05T12:06:10.5026121+00:00</AllowanceStartDate>
      <AllowanceStartDateString>sample string 23</AllowanceStartDateString>
      <AllowanceTypeDetails>
        <AllowanceTypeId>8133143f-a2ff-4364-aafc-f00baaa8ba10</AllowanceTypeId>
        <AllowanceTypeName>sample string 2</AllowanceTypeName>
        <Sequence>3</Sequence>
      </AllowanceTypeDetails>
      <AllowanceTypeId>aa4a2d2f-1d9a-443a-8a62-529459c2ff91</AllowanceTypeId>
      <FirstPaymentDate>2023-12-05T12:06:10.5026121+00:00</FirstPaymentDate>
      <FirstPaymentDateString>sample string 25</FirstPaymentDateString>
      <Hours>12</Hours>
      <IsEnabled>true</IsEnabled>
      <Message>sample string 18</Message>
      <NoOfAllowance>22</NoOfAllowance>
      <PaymentImage>sample string 21</PaymentImage>
      <PaymentScheduleDate>2023-12-05T12:06:10.5026121+00:00</PaymentScheduleDate>
      <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString>
      <ReceiverCardId>eaa50a9d-e510-4156-a24f-c0850aa4a64b</ReceiverCardId>
      <ReceiverFirstName>sample string 5</ReceiverFirstName>
      <ReceiverLastName>sample string 6</ReceiverLastName>
      <ReceiverMobile>sample string 8</ReceiverMobile>
      <ReceiverProfile>sample string 7</ReceiverProfile>
      <ReceiverUserId>e0276e32-351a-453a-83af-425f7a87a8ad</ReceiverUserId>
      <SenderCardId>6fb37cd8-314a-43dd-861d-1106733e0af0</SenderCardId>
      <SenderUserId>1361afa5-b056-40f0-86a8-72ea90a6eea5</SenderUserId>
      <Type>Default</Type>
    </AllowanceViewModel>
  </OneTimerPaymentAllowanceDetails>
  <ProfileImageName>sample string 6</ProfileImageName>
  <UserId>10314df8-ab18-4d98-ac31-4c6c3dc7b002</UserId>
  <UserInviteType>PendingInvite</UserInviteType>
</PendingInviteViewModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PendingInviteViewModel'.

Response Information

Resource Description

ResponseViewModel

Name	Type	Additional information
Status	boolean	None.
StatusCode	integer	None.
Message	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "StatusCode": 2,
  "Message": "sample string 3",
  "Data": {}
}

application/xml, text/xml

Sample:

<ResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <Data />
  <Message>sample string 3</Message>
  <Status>true</Status>
  <StatusCode>2</StatusCode>
</ResponseViewModel>