regis

<back to all web services

CRMDonationsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Donations
POST/DynamicsCRM/Donations/{regent_id}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.DynamicsCRM.Requests
Imports regis.DynamicsCRM.Responses

Namespace Global

    Namespace regis.DynamicsCRM.Requests

        Public Partial Class CRMDonationsRequest
            Public Overridable Property regent_id As Nullable(Of Integer)
            Public Overridable Property from_date As Nullable(Of Date)
            Public Overridable Property to_date As Nullable(Of Date)
            Public Overridable Property start_version_number As Nullable(Of Integer)
            Public Overridable Property end_version_number As Nullable(Of Integer)
            Public Overridable Property is_missing_acknowledgement As Boolean
            Public Overridable Property has_acknowledgement_letter As Boolean
        End Class
    End Namespace

    Namespace regis.DynamicsCRM.Responses

        Public Partial Class CRMDonationResponse
            Public Overridable Property regent_id As Integer
            Public Overridable Property contact_addressee As String
            Public Overridable Property donor_first_name As String
            Public Overridable Property donor_last_name As String
            Public Overridable Property donor_addressee As String
            Public Overridable Property donor_city As String
            Public Overridable Property donor_country As String
            Public Overridable Property donor_owner_full_name As String
            Public Overridable Property is_contact As Boolean
            Public Overridable Property is_account As Boolean
            Public Overridable Property soft_credit_regent_id As Nullable(Of Integer)
            Public Overridable Property soft_credit_contact_addressee As String
            Public Overridable Property soft_credit_contact_first_name As String
            Public Overridable Property soft_credit_contact_last_name As String
            Public Overridable Property soft_credit_contact_spouse_is_main_contact As Boolean
            Public Overridable Property soft_credit_contact_city As String
            Public Overridable Property soft_credit_contact_country As String
            Public Overridable Property soft_credit_contact_owner_full_name As String
            Public Overridable Property soft_credit_second_regent_id As String
            Public Overridable Property soft_credit_second_contact_addressee As String
            Public Overridable Property soft_credit_second_contact_first_name As String
            Public Overridable Property soft_credit_second_contact_last_name As String
            Public Overridable Property soft_credit_second_contact_spouse_is_main_contact As Boolean
            Public Overridable Property soft_credit_second_contact_city As String
            Public Overridable Property soft_credit_second_contact_country As String
            Public Overridable Property soft_credit_second_contact_owner_full_name As String
            Public Overridable Property spouse_is_main_contact As Boolean
            Public Overridable Property import_id As Nullable(Of Integer)
            Public Overridable Property donation_id As String
            Public Overridable Property guid As String
            Public Overridable Property name As String
            Public Overridable Property description As String
            Public Overridable Property appeal_code As String
            Public Overridable Property designation As String
            Public Overridable Property designation_description As String
            Public Overridable Property general_ledger_account_number As String
            Public Overridable Property campaign As String
            Public Overridable Property total_pledge_amount As Decimal
            Public Overridable Property total_paid_amount As Decimal
            Public Overridable Property receipt_amount As Decimal
            Public Overridable Property exchange_rate As Nullable(Of Decimal)
            Public Overridable Property total_paid_canadian_amount As Nullable(Of Decimal)
            Public Overridable Property is_recurring As Boolean
            Public Overridable Property is_parent_donation As Boolean
            Public Overridable Property currency As String
            Public Overridable Property source As String
            Public Overridable Property channel As String
            Public Overridable Property receipting_organization As String
            Public Overridable Property type As String
            Public Overridable Property acknowledgment_sent As Boolean
            Public Overridable Property send_acknowledgment As Boolean
            Public Overridable Property acknowledgment_template_guid As String
            Public Overridable Property parent_guid As String
            Public Overridable Property anonymous As Boolean
            Public Overridable Property gift_date As Nullable(Of Date)
            Public Overridable Property recurring_gift_start_date As Nullable(Of Date)
            Public Overridable Property recurring_gift_end_date As Nullable(Of Date)
            Public Overridable Property cheque_number As String
            Public Overridable Property version_number As Integer
            Public Overridable Property added_date As Nullable(Of Date)
        End Class

        Public Partial Class CRMDonationsResponse
            Public Sub New()
                donations = New List(Of CRMDonationResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property donations As List(Of CRMDonationResponse)
            Public Overridable Property from_date As Nullable(Of Date)
            Public Overridable Property to_date As Nullable(Of Date)
            Public Overridable Property start_version_number As Nullable(Of Integer)
            Public Overridable Property end_version_number As Nullable(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET CRMDonationsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /DynamicsCRM/Donations HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"regent_id":0,"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","start_version_number":0,"end_version_number":0,"is_missing_acknowledgement":false,"has_acknowledgement_letter":false}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"donations":[{"regent_id":0,"contact_addressee":"String","donor_first_name":"String","donor_last_name":"String","donor_addressee":"String","donor_city":"String","donor_country":"String","donor_owner_full_name":"String","is_contact":false,"is_account":false,"soft_credit_regent_id":0,"soft_credit_contact_addressee":"String","soft_credit_contact_first_name":"String","soft_credit_contact_last_name":"String","soft_credit_contact_spouse_is_main_contact":false,"soft_credit_contact_city":"String","soft_credit_contact_country":"String","soft_credit_contact_owner_full_name":"String","soft_credit_second_regent_id":"String","soft_credit_second_contact_addressee":"String","soft_credit_second_contact_first_name":"String","soft_credit_second_contact_last_name":"String","soft_credit_second_contact_spouse_is_main_contact":false,"soft_credit_second_contact_city":"String","soft_credit_second_contact_country":"String","soft_credit_second_contact_owner_full_name":"String","spouse_is_main_contact":false,"import_id":0,"donation_id":"String","guid":"String","name":"String","description":"String","appeal_code":"String","designation":"String","designation_description":"String","general_ledger_account_number":"String","campaign":"String","total_pledge_amount":0,"total_paid_amount":0,"receipt_amount":0,"exchange_rate":0,"total_paid_canadian_amount":0,"is_recurring":false,"is_parent_donation":false,"currency":"String","source":"String","channel":"String","receipting_organization":"String","type":"String","acknowledgment_sent":false,"send_acknowledgment":false,"acknowledgment_template_guid":"String","parent_guid":"String","anonymous":false,"gift_date":"0001-01-01T00:00:00.0000000","recurring_gift_start_date":"0001-01-01T00:00:00.0000000","recurring_gift_end_date":"0001-01-01T00:00:00.0000000","cheque_number":"String","version_number":0,"added_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","start_version_number":0,"end_version_number":0}