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": "af26c873-066f-4660-81d1-3fd3fa2eda27", "UserId": "b0fa2e42-cb71-4694-bd7f-d7ef37036227", "InvitedUserId": "3473a2c1-5e4d-4f00-8ffe-631a93930cda", "ContactName": "sample string 3", "ContactNumber": "sample string 4", "ContactDateTime": "2024-10-15T08:17:35.2732186+00:00", "ProfileImageName": "sample string 6", "IsRegistered": true, "IsFavourite": true, "InviteResponse": 0, "AllowanceViewModel": { "AllowanceId": "365ecdef-5ac9-4aa1-a448-02479cf6302c", "SenderUserId": "8c87c340-23fc-408a-bd26-78b67af674df", "ReceiverUserId": "021dd740-5c98-44df-9441-ec3a4001667c", "SenderCardId": "21c6f6ac-a2c8-4de9-9116-ef5c7babad29", "ReceiverCardId": "1ba058f8-02b1-40fb-b0fa-b74da9692cad", "ReceiverFirstName": "sample string 5", "ReceiverLastName": "sample string 6", "ReceiverProfile": "sample string 7", "ReceiverMobile": "sample string 8", "AllowanceName": "sample string 9", "AllowanceDateTime": "2024-10-15T08:17:35.2732186+00:00", "IsEnabled": true, "Hours": 12, "AllowanceTypeId": "490a0195-6e9d-40e2-9c4f-6e21cec0881a", "AllowancePatternId": "4c0a8255-d9cc-4783-92e2-f99f463e2256", "AllowanceAmount": 15.1, "AllowanceCurrency": "sample string 16", "AllowancePatternName": "sample string 17", "AllowanceTypeDetails": { "AllowanceTypeId": "8291559c-769d-4850-b90e-fa3327cc051f", "AllowanceTypeName": "sample string 2", "Sequence": 3 }, "AllowancePatternDetails": { "AllowancePatternId": "cf604d0d-4ecb-418d-9234-cd10dcb36432", "PatternName": "sample string 2", "AllowanceTypeId": "e7ad3fcc-a569-4cdb-b383-cb08d23d599c", "Sequence": 4, "PatternNumber": 5 }, "Type": 0, "Message": "sample string 18", "PaymentScheduleDateString": "sample string 19", "PaymentScheduleDate": "2024-10-15T08:17:35.2732186+00:00", "PaymentImage": "sample string 21", "NoOfAllowance": 22, "AllowanceStartDateString": "sample string 23", "AllowanceEndDateString": "sample string 24", "FirstPaymentDateString": "sample string 25", "FirstPaymentDate": "2024-10-15T08:17:35.2732186+00:00", "AllowanceStartDate": "2024-10-15T08:17:35.2732186+00:00", "AllowanceEndDate": "2024-10-15T08:17:35.2732186+00:00" }, "OneTimerPaymentAllowanceDetails": [ { "AllowanceId": "365ecdef-5ac9-4aa1-a448-02479cf6302c", "SenderUserId": "8c87c340-23fc-408a-bd26-78b67af674df", "ReceiverUserId": "021dd740-5c98-44df-9441-ec3a4001667c", "SenderCardId": "21c6f6ac-a2c8-4de9-9116-ef5c7babad29", "ReceiverCardId": "1ba058f8-02b1-40fb-b0fa-b74da9692cad", "ReceiverFirstName": "sample string 5", "ReceiverLastName": "sample string 6", "ReceiverProfile": "sample string 7", "ReceiverMobile": "sample string 8", "AllowanceName": "sample string 9", "AllowanceDateTime": "2024-10-15T08:17:35.2732186+00:00", "IsEnabled": true, "Hours": 12, "AllowanceTypeId": "490a0195-6e9d-40e2-9c4f-6e21cec0881a", "AllowancePatternId": "4c0a8255-d9cc-4783-92e2-f99f463e2256", "AllowanceAmount": 15.1, "AllowanceCurrency": "sample string 16", "AllowancePatternName": "sample string 17", "AllowanceTypeDetails": { "AllowanceTypeId": "8291559c-769d-4850-b90e-fa3327cc051f", "AllowanceTypeName": "sample string 2", "Sequence": 3 }, "AllowancePatternDetails": { "AllowancePatternId": "cf604d0d-4ecb-418d-9234-cd10dcb36432", "PatternName": "sample string 2", "AllowanceTypeId": "e7ad3fcc-a569-4cdb-b383-cb08d23d599c", "Sequence": 4, "PatternNumber": 5 }, "Type": 0, "Message": "sample string 18", "PaymentScheduleDateString": "sample string 19", "PaymentScheduleDate": "2024-10-15T08:17:35.2732186+00:00", "PaymentImage": "sample string 21", "NoOfAllowance": 22, "AllowanceStartDateString": "sample string 23", "AllowanceEndDateString": "sample string 24", "FirstPaymentDateString": "sample string 25", "FirstPaymentDate": "2024-10-15T08:17:35.2732186+00:00", "AllowanceStartDate": "2024-10-15T08:17:35.2732186+00:00", "AllowanceEndDate": "2024-10-15T08:17:35.2732186+00:00" }, { "AllowanceId": "365ecdef-5ac9-4aa1-a448-02479cf6302c", "SenderUserId": "8c87c340-23fc-408a-bd26-78b67af674df", "ReceiverUserId": "021dd740-5c98-44df-9441-ec3a4001667c", "SenderCardId": "21c6f6ac-a2c8-4de9-9116-ef5c7babad29", "ReceiverCardId": "1ba058f8-02b1-40fb-b0fa-b74da9692cad", "ReceiverFirstName": "sample string 5", "ReceiverLastName": "sample string 6", "ReceiverProfile": "sample string 7", "ReceiverMobile": "sample string 8", "AllowanceName": "sample string 9", "AllowanceDateTime": "2024-10-15T08:17:35.2732186+00:00", "IsEnabled": true, "Hours": 12, "AllowanceTypeId": "490a0195-6e9d-40e2-9c4f-6e21cec0881a", "AllowancePatternId": "4c0a8255-d9cc-4783-92e2-f99f463e2256", "AllowanceAmount": 15.1, "AllowanceCurrency": "sample string 16", "AllowancePatternName": "sample string 17", "AllowanceTypeDetails": { "AllowanceTypeId": "8291559c-769d-4850-b90e-fa3327cc051f", "AllowanceTypeName": "sample string 2", "Sequence": 3 }, "AllowancePatternDetails": { "AllowancePatternId": "cf604d0d-4ecb-418d-9234-cd10dcb36432", "PatternName": "sample string 2", "AllowanceTypeId": "e7ad3fcc-a569-4cdb-b383-cb08d23d599c", "Sequence": 4, "PatternNumber": 5 }, "Type": 0, "Message": "sample string 18", "PaymentScheduleDateString": "sample string 19", "PaymentScheduleDate": "2024-10-15T08:17:35.2732186+00:00", "PaymentImage": "sample string 21", "NoOfAllowance": 22, "AllowanceStartDateString": "sample string 23", "AllowanceEndDateString": "sample string 24", "FirstPaymentDateString": "sample string 25", "FirstPaymentDate": "2024-10-15T08:17:35.2732186+00:00", "AllowanceStartDate": "2024-10-15T08:17:35.2732186+00:00", "AllowanceEndDate": "2024-10-15T08:17:35.2732186+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>2024-10-15T08:17:35.2732186+00:00</AllowanceDateTime> <AllowanceEndDate>2024-10-15T08:17:35.2732186+00:00</AllowanceEndDate> <AllowanceEndDateString>sample string 24</AllowanceEndDateString> <AllowanceId>365ecdef-5ac9-4aa1-a448-02479cf6302c</AllowanceId> <AllowanceName>sample string 9</AllowanceName> <AllowancePatternDetails> <AllowancePatternId>cf604d0d-4ecb-418d-9234-cd10dcb36432</AllowancePatternId> <AllowanceTypeId>e7ad3fcc-a569-4cdb-b383-cb08d23d599c</AllowanceTypeId> <PatternName>sample string 2</PatternName> <PatternNumber>5</PatternNumber> <Sequence>4</Sequence> </AllowancePatternDetails> <AllowancePatternId>4c0a8255-d9cc-4783-92e2-f99f463e2256</AllowancePatternId> <AllowancePatternName>sample string 17</AllowancePatternName> <AllowanceStartDate>2024-10-15T08:17:35.2732186+00:00</AllowanceStartDate> <AllowanceStartDateString>sample string 23</AllowanceStartDateString> <AllowanceTypeDetails> <AllowanceTypeId>8291559c-769d-4850-b90e-fa3327cc051f</AllowanceTypeId> <AllowanceTypeName>sample string 2</AllowanceTypeName> <Sequence>3</Sequence> </AllowanceTypeDetails> <AllowanceTypeId>490a0195-6e9d-40e2-9c4f-6e21cec0881a</AllowanceTypeId> <FirstPaymentDate>2024-10-15T08:17:35.2732186+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>2024-10-15T08:17:35.2732186+00:00</PaymentScheduleDate> <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString> <ReceiverCardId>1ba058f8-02b1-40fb-b0fa-b74da9692cad</ReceiverCardId> <ReceiverFirstName>sample string 5</ReceiverFirstName> <ReceiverLastName>sample string 6</ReceiverLastName> <ReceiverMobile>sample string 8</ReceiverMobile> <ReceiverProfile>sample string 7</ReceiverProfile> <ReceiverUserId>021dd740-5c98-44df-9441-ec3a4001667c</ReceiverUserId> <SenderCardId>21c6f6ac-a2c8-4de9-9116-ef5c7babad29</SenderCardId> <SenderUserId>8c87c340-23fc-408a-bd26-78b67af674df</SenderUserId> <Type>Default</Type> </AllowanceViewModel> <ContactDateTime>2024-10-15T08:17:35.2732186+00:00</ContactDateTime> <ContactId>af26c873-066f-4660-81d1-3fd3fa2eda27</ContactId> <ContactName>sample string 3</ContactName> <ContactNumber>sample string 4</ContactNumber> <InviteResponse>Default</InviteResponse> <InvitedUserId>3473a2c1-5e4d-4f00-8ffe-631a93930cda</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>2024-10-15T08:17:35.2732186+00:00</AllowanceDateTime> <AllowanceEndDate>2024-10-15T08:17:35.2732186+00:00</AllowanceEndDate> <AllowanceEndDateString>sample string 24</AllowanceEndDateString> <AllowanceId>365ecdef-5ac9-4aa1-a448-02479cf6302c</AllowanceId> <AllowanceName>sample string 9</AllowanceName> <AllowancePatternDetails> <AllowancePatternId>cf604d0d-4ecb-418d-9234-cd10dcb36432</AllowancePatternId> <AllowanceTypeId>e7ad3fcc-a569-4cdb-b383-cb08d23d599c</AllowanceTypeId> <PatternName>sample string 2</PatternName> <PatternNumber>5</PatternNumber> <Sequence>4</Sequence> </AllowancePatternDetails> <AllowancePatternId>4c0a8255-d9cc-4783-92e2-f99f463e2256</AllowancePatternId> <AllowancePatternName>sample string 17</AllowancePatternName> <AllowanceStartDate>2024-10-15T08:17:35.2732186+00:00</AllowanceStartDate> <AllowanceStartDateString>sample string 23</AllowanceStartDateString> <AllowanceTypeDetails> <AllowanceTypeId>8291559c-769d-4850-b90e-fa3327cc051f</AllowanceTypeId> <AllowanceTypeName>sample string 2</AllowanceTypeName> <Sequence>3</Sequence> </AllowanceTypeDetails> <AllowanceTypeId>490a0195-6e9d-40e2-9c4f-6e21cec0881a</AllowanceTypeId> <FirstPaymentDate>2024-10-15T08:17:35.2732186+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>2024-10-15T08:17:35.2732186+00:00</PaymentScheduleDate> <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString> <ReceiverCardId>1ba058f8-02b1-40fb-b0fa-b74da9692cad</ReceiverCardId> <ReceiverFirstName>sample string 5</ReceiverFirstName> <ReceiverLastName>sample string 6</ReceiverLastName> <ReceiverMobile>sample string 8</ReceiverMobile> <ReceiverProfile>sample string 7</ReceiverProfile> <ReceiverUserId>021dd740-5c98-44df-9441-ec3a4001667c</ReceiverUserId> <SenderCardId>21c6f6ac-a2c8-4de9-9116-ef5c7babad29</SenderCardId> <SenderUserId>8c87c340-23fc-408a-bd26-78b67af674df</SenderUserId> <Type>Default</Type> </AllowanceViewModel> <AllowanceViewModel> <AllowanceAmount>15.1</AllowanceAmount> <AllowanceCurrency>sample string 16</AllowanceCurrency> <AllowanceDateTime>2024-10-15T08:17:35.2732186+00:00</AllowanceDateTime> <AllowanceEndDate>2024-10-15T08:17:35.2732186+00:00</AllowanceEndDate> <AllowanceEndDateString>sample string 24</AllowanceEndDateString> <AllowanceId>365ecdef-5ac9-4aa1-a448-02479cf6302c</AllowanceId> <AllowanceName>sample string 9</AllowanceName> <AllowancePatternDetails> <AllowancePatternId>cf604d0d-4ecb-418d-9234-cd10dcb36432</AllowancePatternId> <AllowanceTypeId>e7ad3fcc-a569-4cdb-b383-cb08d23d599c</AllowanceTypeId> <PatternName>sample string 2</PatternName> <PatternNumber>5</PatternNumber> <Sequence>4</Sequence> </AllowancePatternDetails> <AllowancePatternId>4c0a8255-d9cc-4783-92e2-f99f463e2256</AllowancePatternId> <AllowancePatternName>sample string 17</AllowancePatternName> <AllowanceStartDate>2024-10-15T08:17:35.2732186+00:00</AllowanceStartDate> <AllowanceStartDateString>sample string 23</AllowanceStartDateString> <AllowanceTypeDetails> <AllowanceTypeId>8291559c-769d-4850-b90e-fa3327cc051f</AllowanceTypeId> <AllowanceTypeName>sample string 2</AllowanceTypeName> <Sequence>3</Sequence> </AllowanceTypeDetails> <AllowanceTypeId>490a0195-6e9d-40e2-9c4f-6e21cec0881a</AllowanceTypeId> <FirstPaymentDate>2024-10-15T08:17:35.2732186+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>2024-10-15T08:17:35.2732186+00:00</PaymentScheduleDate> <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString> <ReceiverCardId>1ba058f8-02b1-40fb-b0fa-b74da9692cad</ReceiverCardId> <ReceiverFirstName>sample string 5</ReceiverFirstName> <ReceiverLastName>sample string 6</ReceiverLastName> <ReceiverMobile>sample string 8</ReceiverMobile> <ReceiverProfile>sample string 7</ReceiverProfile> <ReceiverUserId>021dd740-5c98-44df-9441-ec3a4001667c</ReceiverUserId> <SenderCardId>21c6f6ac-a2c8-4de9-9116-ef5c7babad29</SenderCardId> <SenderUserId>8c87c340-23fc-408a-bd26-78b67af674df</SenderUserId> <Type>Default</Type> </AllowanceViewModel> </OneTimerPaymentAllowanceDetails> <ProfileImageName>sample string 6</ProfileImageName> <UserId>b0fa2e42-cb71-4694-bd7f-d7ef37036227</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>