POST api/BankiomCommunity/SendInvites
Request Information
URI Parameters
None.
Body Parameters
PendingInviteViewModelName | Description | 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": "bbc52ec1-e44f-424c-befb-4850d6b52926", "UserId": "e65f455d-5588-49d5-832e-036e40288ec3", "InvitedUserId": "e42d3de1-1705-4227-80a3-e74e46bbb139", "ContactName": "sample string 3", "ContactNumber": "sample string 4", "ContactDateTime": "2023-06-08T08:21:16.2878464+00:00", "ProfileImageName": "sample string 6", "IsRegistered": true, "IsFavourite": true, "InviteResponse": 0, "AllowanceViewModel": { "AllowanceId": "280ba0c7-0f63-435f-873c-1619f21c8872", "SenderUserId": "38ef16da-1a0d-485e-964a-e11d01833e71", "ReceiverUserId": "7f79cb8d-d520-459a-9418-71307e03338d", "SenderCardId": "675db7a5-95d1-41c2-af2d-2f08840ccbbd", "ReceiverCardId": "986fc69a-ddd8-42dc-8a70-523faf263f32", "ReceiverFirstName": "sample string 5", "ReceiverLastName": "sample string 6", "ReceiverProfile": "sample string 7", "ReceiverMobile": "sample string 8", "AllowanceName": "sample string 9", "AllowanceDateTime": "2023-06-08T08:21:16.2878464+00:00", "IsEnabled": true, "Hours": 12, "AllowanceTypeId": "d872eeeb-cb45-43ec-bc2c-44d6a5f5d7ed", "AllowancePatternId": "eb5aa3bf-cda0-4126-ba03-420701133867", "AllowanceAmount": 15.1, "AllowanceCurrency": "sample string 16", "AllowancePatternName": "sample string 17", "AllowanceTypeDetails": { "AllowanceTypeId": "779765e0-62e9-4838-b870-9a963799d949", "AllowanceTypeName": "sample string 2", "Sequence": 3 }, "AllowancePatternDetails": { "AllowancePatternId": "c481d28d-fc91-44c5-ae2e-e9fd30e23b82", "PatternName": "sample string 2", "AllowanceTypeId": "36b027dd-50f7-4033-ac58-6c46432867c8", "Sequence": 4, "PatternNumber": 5 }, "Type": 0, "Message": "sample string 18", "PaymentScheduleDateString": "sample string 19", "PaymentScheduleDate": "2023-06-08T08:21:16.2878464+00:00", "PaymentImage": "sample string 21", "NoOfAllowance": 22, "AllowanceStartDateString": "sample string 23", "AllowanceEndDateString": "sample string 24", "FirstPaymentDateString": "sample string 25", "FirstPaymentDate": "2023-06-08T08:21:16.2878464+00:00", "AllowanceStartDate": "2023-06-08T08:21:16.2878464+00:00", "AllowanceEndDate": "2023-06-08T08:21:16.2878464+00:00" }, "OneTimerPaymentAllowanceDetails": [ { "AllowanceId": "280ba0c7-0f63-435f-873c-1619f21c8872", "SenderUserId": "38ef16da-1a0d-485e-964a-e11d01833e71", "ReceiverUserId": "7f79cb8d-d520-459a-9418-71307e03338d", "SenderCardId": "675db7a5-95d1-41c2-af2d-2f08840ccbbd", "ReceiverCardId": "986fc69a-ddd8-42dc-8a70-523faf263f32", "ReceiverFirstName": "sample string 5", "ReceiverLastName": "sample string 6", "ReceiverProfile": "sample string 7", "ReceiverMobile": "sample string 8", "AllowanceName": "sample string 9", "AllowanceDateTime": "2023-06-08T08:21:16.2878464+00:00", "IsEnabled": true, "Hours": 12, "AllowanceTypeId": "d872eeeb-cb45-43ec-bc2c-44d6a5f5d7ed", "AllowancePatternId": "eb5aa3bf-cda0-4126-ba03-420701133867", "AllowanceAmount": 15.1, "AllowanceCurrency": "sample string 16", "AllowancePatternName": "sample string 17", "AllowanceTypeDetails": { "AllowanceTypeId": "779765e0-62e9-4838-b870-9a963799d949", "AllowanceTypeName": "sample string 2", "Sequence": 3 }, "AllowancePatternDetails": { "AllowancePatternId": "c481d28d-fc91-44c5-ae2e-e9fd30e23b82", "PatternName": "sample string 2", "AllowanceTypeId": "36b027dd-50f7-4033-ac58-6c46432867c8", "Sequence": 4, "PatternNumber": 5 }, "Type": 0, "Message": "sample string 18", "PaymentScheduleDateString": "sample string 19", "PaymentScheduleDate": "2023-06-08T08:21:16.2878464+00:00", "PaymentImage": "sample string 21", "NoOfAllowance": 22, "AllowanceStartDateString": "sample string 23", "AllowanceEndDateString": "sample string 24", "FirstPaymentDateString": "sample string 25", "FirstPaymentDate": "2023-06-08T08:21:16.2878464+00:00", "AllowanceStartDate": "2023-06-08T08:21:16.2878464+00:00", "AllowanceEndDate": "2023-06-08T08:21:16.2878464+00:00" }, { "AllowanceId": "280ba0c7-0f63-435f-873c-1619f21c8872", "SenderUserId": "38ef16da-1a0d-485e-964a-e11d01833e71", "ReceiverUserId": "7f79cb8d-d520-459a-9418-71307e03338d", "SenderCardId": "675db7a5-95d1-41c2-af2d-2f08840ccbbd", "ReceiverCardId": "986fc69a-ddd8-42dc-8a70-523faf263f32", "ReceiverFirstName": "sample string 5", "ReceiverLastName": "sample string 6", "ReceiverProfile": "sample string 7", "ReceiverMobile": "sample string 8", "AllowanceName": "sample string 9", "AllowanceDateTime": "2023-06-08T08:21:16.2878464+00:00", "IsEnabled": true, "Hours": 12, "AllowanceTypeId": "d872eeeb-cb45-43ec-bc2c-44d6a5f5d7ed", "AllowancePatternId": "eb5aa3bf-cda0-4126-ba03-420701133867", "AllowanceAmount": 15.1, "AllowanceCurrency": "sample string 16", "AllowancePatternName": "sample string 17", "AllowanceTypeDetails": { "AllowanceTypeId": "779765e0-62e9-4838-b870-9a963799d949", "AllowanceTypeName": "sample string 2", "Sequence": 3 }, "AllowancePatternDetails": { "AllowancePatternId": "c481d28d-fc91-44c5-ae2e-e9fd30e23b82", "PatternName": "sample string 2", "AllowanceTypeId": "36b027dd-50f7-4033-ac58-6c46432867c8", "Sequence": 4, "PatternNumber": 5 }, "Type": 0, "Message": "sample string 18", "PaymentScheduleDateString": "sample string 19", "PaymentScheduleDate": "2023-06-08T08:21:16.2878464+00:00", "PaymentImage": "sample string 21", "NoOfAllowance": 22, "AllowanceStartDateString": "sample string 23", "AllowanceEndDateString": "sample string 24", "FirstPaymentDateString": "sample string 25", "FirstPaymentDate": "2023-06-08T08:21:16.2878464+00:00", "AllowanceStartDate": "2023-06-08T08:21:16.2878464+00:00", "AllowanceEndDate": "2023-06-08T08:21:16.2878464+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-06-08T08:21:16.2878464+00:00</AllowanceDateTime> <AllowanceEndDate>2023-06-08T08:21:16.2878464+00:00</AllowanceEndDate> <AllowanceEndDateString>sample string 24</AllowanceEndDateString> <AllowanceId>280ba0c7-0f63-435f-873c-1619f21c8872</AllowanceId> <AllowanceName>sample string 9</AllowanceName> <AllowancePatternDetails> <AllowancePatternId>c481d28d-fc91-44c5-ae2e-e9fd30e23b82</AllowancePatternId> <AllowanceTypeId>36b027dd-50f7-4033-ac58-6c46432867c8</AllowanceTypeId> <PatternName>sample string 2</PatternName> <PatternNumber>5</PatternNumber> <Sequence>4</Sequence> </AllowancePatternDetails> <AllowancePatternId>eb5aa3bf-cda0-4126-ba03-420701133867</AllowancePatternId> <AllowancePatternName>sample string 17</AllowancePatternName> <AllowanceStartDate>2023-06-08T08:21:16.2878464+00:00</AllowanceStartDate> <AllowanceStartDateString>sample string 23</AllowanceStartDateString> <AllowanceTypeDetails> <AllowanceTypeId>779765e0-62e9-4838-b870-9a963799d949</AllowanceTypeId> <AllowanceTypeName>sample string 2</AllowanceTypeName> <Sequence>3</Sequence> </AllowanceTypeDetails> <AllowanceTypeId>d872eeeb-cb45-43ec-bc2c-44d6a5f5d7ed</AllowanceTypeId> <FirstPaymentDate>2023-06-08T08:21:16.2878464+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-06-08T08:21:16.2878464+00:00</PaymentScheduleDate> <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString> <ReceiverCardId>986fc69a-ddd8-42dc-8a70-523faf263f32</ReceiverCardId> <ReceiverFirstName>sample string 5</ReceiverFirstName> <ReceiverLastName>sample string 6</ReceiverLastName> <ReceiverMobile>sample string 8</ReceiverMobile> <ReceiverProfile>sample string 7</ReceiverProfile> <ReceiverUserId>7f79cb8d-d520-459a-9418-71307e03338d</ReceiverUserId> <SenderCardId>675db7a5-95d1-41c2-af2d-2f08840ccbbd</SenderCardId> <SenderUserId>38ef16da-1a0d-485e-964a-e11d01833e71</SenderUserId> <Type>Default</Type> </AllowanceViewModel> <ContactDateTime>2023-06-08T08:21:16.2878464+00:00</ContactDateTime> <ContactId>bbc52ec1-e44f-424c-befb-4850d6b52926</ContactId> <ContactName>sample string 3</ContactName> <ContactNumber>sample string 4</ContactNumber> <InviteResponse>Default</InviteResponse> <InvitedUserId>e42d3de1-1705-4227-80a3-e74e46bbb139</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-06-08T08:21:16.2878464+00:00</AllowanceDateTime> <AllowanceEndDate>2023-06-08T08:21:16.2878464+00:00</AllowanceEndDate> <AllowanceEndDateString>sample string 24</AllowanceEndDateString> <AllowanceId>280ba0c7-0f63-435f-873c-1619f21c8872</AllowanceId> <AllowanceName>sample string 9</AllowanceName> <AllowancePatternDetails> <AllowancePatternId>c481d28d-fc91-44c5-ae2e-e9fd30e23b82</AllowancePatternId> <AllowanceTypeId>36b027dd-50f7-4033-ac58-6c46432867c8</AllowanceTypeId> <PatternName>sample string 2</PatternName> <PatternNumber>5</PatternNumber> <Sequence>4</Sequence> </AllowancePatternDetails> <AllowancePatternId>eb5aa3bf-cda0-4126-ba03-420701133867</AllowancePatternId> <AllowancePatternName>sample string 17</AllowancePatternName> <AllowanceStartDate>2023-06-08T08:21:16.2878464+00:00</AllowanceStartDate> <AllowanceStartDateString>sample string 23</AllowanceStartDateString> <AllowanceTypeDetails> <AllowanceTypeId>779765e0-62e9-4838-b870-9a963799d949</AllowanceTypeId> <AllowanceTypeName>sample string 2</AllowanceTypeName> <Sequence>3</Sequence> </AllowanceTypeDetails> <AllowanceTypeId>d872eeeb-cb45-43ec-bc2c-44d6a5f5d7ed</AllowanceTypeId> <FirstPaymentDate>2023-06-08T08:21:16.2878464+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-06-08T08:21:16.2878464+00:00</PaymentScheduleDate> <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString> <ReceiverCardId>986fc69a-ddd8-42dc-8a70-523faf263f32</ReceiverCardId> <ReceiverFirstName>sample string 5</ReceiverFirstName> <ReceiverLastName>sample string 6</ReceiverLastName> <ReceiverMobile>sample string 8</ReceiverMobile> <ReceiverProfile>sample string 7</ReceiverProfile> <ReceiverUserId>7f79cb8d-d520-459a-9418-71307e03338d</ReceiverUserId> <SenderCardId>675db7a5-95d1-41c2-af2d-2f08840ccbbd</SenderCardId> <SenderUserId>38ef16da-1a0d-485e-964a-e11d01833e71</SenderUserId> <Type>Default</Type> </AllowanceViewModel> <AllowanceViewModel> <AllowanceAmount>15.1</AllowanceAmount> <AllowanceCurrency>sample string 16</AllowanceCurrency> <AllowanceDateTime>2023-06-08T08:21:16.2878464+00:00</AllowanceDateTime> <AllowanceEndDate>2023-06-08T08:21:16.2878464+00:00</AllowanceEndDate> <AllowanceEndDateString>sample string 24</AllowanceEndDateString> <AllowanceId>280ba0c7-0f63-435f-873c-1619f21c8872</AllowanceId> <AllowanceName>sample string 9</AllowanceName> <AllowancePatternDetails> <AllowancePatternId>c481d28d-fc91-44c5-ae2e-e9fd30e23b82</AllowancePatternId> <AllowanceTypeId>36b027dd-50f7-4033-ac58-6c46432867c8</AllowanceTypeId> <PatternName>sample string 2</PatternName> <PatternNumber>5</PatternNumber> <Sequence>4</Sequence> </AllowancePatternDetails> <AllowancePatternId>eb5aa3bf-cda0-4126-ba03-420701133867</AllowancePatternId> <AllowancePatternName>sample string 17</AllowancePatternName> <AllowanceStartDate>2023-06-08T08:21:16.2878464+00:00</AllowanceStartDate> <AllowanceStartDateString>sample string 23</AllowanceStartDateString> <AllowanceTypeDetails> <AllowanceTypeId>779765e0-62e9-4838-b870-9a963799d949</AllowanceTypeId> <AllowanceTypeName>sample string 2</AllowanceTypeName> <Sequence>3</Sequence> </AllowanceTypeDetails> <AllowanceTypeId>d872eeeb-cb45-43ec-bc2c-44d6a5f5d7ed</AllowanceTypeId> <FirstPaymentDate>2023-06-08T08:21:16.2878464+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-06-08T08:21:16.2878464+00:00</PaymentScheduleDate> <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString> <ReceiverCardId>986fc69a-ddd8-42dc-8a70-523faf263f32</ReceiverCardId> <ReceiverFirstName>sample string 5</ReceiverFirstName> <ReceiverLastName>sample string 6</ReceiverLastName> <ReceiverMobile>sample string 8</ReceiverMobile> <ReceiverProfile>sample string 7</ReceiverProfile> <ReceiverUserId>7f79cb8d-d520-459a-9418-71307e03338d</ReceiverUserId> <SenderCardId>675db7a5-95d1-41c2-af2d-2f08840ccbbd</SenderCardId> <SenderUserId>38ef16da-1a0d-485e-964a-e11d01833e71</SenderUserId> <Type>Default</Type> </AllowanceViewModel> </OneTimerPaymentAllowanceDetails> <ProfileImageName>sample string 6</ProfileImageName> <UserId>e65f455d-5588-49d5-832e-036e40288ec3</UserId> <UserInviteType>PendingInvite</UserInviteType> </PendingInviteViewModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
ResponseViewModelName | Description | 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>