JiwaAPI

<back to all web services

DebtorGroupMembershipPOSTRequest

Requires Authentication
The following routes are available for this service:
POST/Debtors/{DebtorID}/GroupMembershipsAppends a group membership to a debtor.
DebtorGroupMembershipPOSTRequest Parameters:
NameParameterData TypeRequiredDescription
DebtorIDpathstringNo
DebtorGroupMembership Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformbool?No
GroupMembershipIDformstringNo
GroupRecIDformstringNo
GroupDescriptionformstringNo
StaffIDformstringNo
StaffUsernameformstringNo
StaffTitleformstringNo
StaffFirstNameformstringNo
StaffSurnameformstringNo
LastSavedDateTimeformDateTime?No
ItemNoformint?No
DebtorGroupMembership Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformbool?No
GroupMembershipIDformstringNo
GroupRecIDformstringNo
GroupDescriptionformstringNo
StaffIDformstringNo
StaffUsernameformstringNo
StaffTitleformstringNo
StaffFirstNameformstringNo
StaffSurnameformstringNo
LastSavedDateTimeformDateTime?No
ItemNoformint?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Debtors/{DebtorID}/GroupMemberships HTTP/1.1 
Host: api.jiwa.com.au 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DebtorID":"String","IsDefault":false,"GroupRecID":"String","GroupDescription":"String","StaffID":"String","StaffUsername":"String","StaffTitle":"String","StaffFirstName":"String","StaffSurname":"String","ItemNo":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"IsDefault":false,"GroupMembershipID":"String","GroupRecID":"String","GroupDescription":"String","StaffID":"String","StaffUsername":"String","StaffTitle":"String","StaffFirstName":"String","StaffSurname":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","ItemNo":0}