regis

<back to all web services

CRMCRUXUpsertRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/CRUX/Upsert
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMCRUXSubscriptionUpsertRequest:
    payment_amount: Decimal = decimal.Decimal(0)
    import_id: Optional[int] = None
    payment_date: Optional[datetime.datetime] = None
    start_date: Optional[datetime.datetime] = None
    end_date: Optional[datetime.datetime] = None
    added_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CRMCRUXUpsertRequest:
    regent_id: int = 0
    status: Optional[str] = None
    notes: Optional[str] = None
    is_contact: bool = False
    is_account: bool = False
    subscriptions: Optional[List[CRMCRUXSubscriptionUpsertRequest]] = None

Python CRMCRUXUpsertRequest DTOs

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

HTTP + JSV

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

POST /DynamicsCRM/CRUX/Upsert HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	regent_id: 0,
	status: String,
	notes: String,
	is_contact: False,
	is_account: False,
	subscriptions: 
	[
		{
			payment_amount: 0,
			import_id: 0,
			payment_date: 0001-01-01,
			start_date: 0001-01-01,
			end_date: 0001-01-01,
			added_date: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errorCode: String,
	message: String,
	stackTrace: String,
	errors: 
	[
		{
			errorCode: String,
			fieldName: String,
			message: String,
			meta: 
			{
				String: String
			}
		}
	],
	meta: 
	{
		String: String
	}
}