Controller for utility methods API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

GET /api/utils/addmissingcertificationcontacts

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/addmissingchaptercontacts/{tenantid}

tenantid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/adminreviewcertifications

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/applyseeddata/{tenantid}

tenantid: string
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/autorenewfreememberships

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

POST /api/utils/canceleventtransactions/{eventid}/

eventid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/cleanupaftergz23879

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/completedcertifications

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/convertdonotcontactemailtonomassemails

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/countrieslist

Response Example (200 OK)
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/utils/currenttenanttime

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/deniedcertifications

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/dropcontactrolejob

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/dropcontactrolejob/{date}

date: string
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

Validates email address entered in public modules

POST /api/utils/email/validate

Validates email address entered in public modules

Email data to validate

Request Example
{
  "emailAddress": "string"
}

Json value with email validation data

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/enableemaildesigner

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

Throws an error code so we can see the response

GET /api/utils/error/{errorcode}

Throws an error code so we can see the response

errorcode: integer
in path

Http error code

The error code

Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

GET /api/utils/expiredcertifications

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/expiremembershipsjob

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/expiringcertifications

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/findtenantkeys/{username}

username: string
in path

(no description)

200 OK

OK

type
Response Example (200 OK)
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]

GET /api/utils/fixmembershipenddate

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/getallapiinfo

Response Example (200 OK)
[
  {
    "Comparer": "string",
    "Count": "integer",
    "Keys": "string",
    "System.Collections.Generic.IDictionary<TKey,TValue>.Keys": "string",
    "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys": "string",
    "Values": "string",
    "System.Collections.Generic.IDictionary<TKey,TValue>.Values": "string",
    "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values": "string",
    "this[]": "string",
    "System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly": "boolean",
    "System.Collections.ICollection.IsSynchronized": "boolean",
    "System.Collections.ICollection.SyncRoot": "string",
    "System.Collections.IDictionary.IsFixedSize": "boolean",
    "System.Collections.IDictionary.IsReadOnly": "boolean",
    "System.Collections.IDictionary.Keys": "string",
    "System.Collections.IDictionary.Values": "string",
    "System.Collections.IDictionary.Item": "string"
  }
]

GET /api/utils/getallapiinfo/group

Response Example (200 OK)
[
  {
    "Comparer": "string",
    "Count": "integer",
    "Keys": "string",
    "System.Collections.Generic.IDictionary<TKey,TValue>.Keys": "string",
    "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys": "string",
    "Values": "string",
    "System.Collections.Generic.IDictionary<TKey,TValue>.Values": "string",
    "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values": "string",
    "this[]": "integer",
    "System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly": "boolean",
    "System.Collections.ICollection.IsSynchronized": "boolean",
    "System.Collections.ICollection.SyncRoot": "string",
    "System.Collections.IDictionary.IsFixedSize": "boolean",
    "System.Collections.IDictionary.IsReadOnly": "boolean",
    "System.Collections.IDictionary.Keys": "string",
    "System.Collections.IDictionary.Values": "string",
    "System.Collections.IDictionary.Item": "string"
  }
]

GET /api/utils/getallapiinfoforintegrationtesting

200 OK

OK

GET /api/utils/getfielddatasourcename

id: integer
in query

(no description)

200 OK

OK

type
Response Example (200 OK)
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]

POST /api/utils/gz39999/recreatejob

Safe to delete after 2023-03-20

undefined

Request Example
{
  "key": "string",
  "TenantId": "integer",
  "JobIds": "string"
}
Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

Checks in on hangfire operation

GET /api/utils/health/backgroundprocessing

Checks in on hangfire operation

200 if successfully stored data

Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

GET /api/utils/health/backgroundprocessing/fixup

Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

Checks in on external service

GET /api/utils/health/serviceavailability/{servicename}

Checks in on external service

servicename: string
in path

(no description)

200 if successfully stored data

Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

GET /api/utils/integrationtests/savenarpaymentsystemnumbertofile

tenantid: integer
in query

(no description)

200 OK

OK

Used for integration testing of the Nar payments/refunds Keeps track of the NARPaymentSystemNumber in Azure, updating the TenantSequences table, which gets removed after integration test are run.

GET /api/utils/integrationtests/setupnarpaymentsystemnumber

Used for integration testing of the Nar payments/refunds Keeps track of the NARPaymentSystemNumber in Azure, updating the TenantSequences table, which gets removed after integration test are run.

tenantid: integer
in query

(no description)

200 OK

The next valid NARPaymentSystemNumber (AssociationRequestId)

type
Response Example (200 OK)
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]

GET /api/utils/maintaindemomode

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/populatetransferreportdata/{paymentgatewayid}/{fromdate}/{todate}

paymentgatewayid: integer
in path

(no description)

fromdate: string
in path

(no description)

todate: string
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/pushstaff

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/recalculatepricemembershiprenewalpricesjob/{tenantid}

tenantid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

POST /api/utils/refund/validate

undefined

Request Example
{
  "ChargeRefundAmount": "string",
  "PaymentRefundedAmount": "string",
  "AreAmountsDifferent": "boolean",
  "ShowChargeRefundAmountMessage": "string",
  "RefundDate": "string",
  "Notes": "string",
  "ContactId": "integer",
  "EPaymentTransactionId": "string",
  "PaymentId": "integer",
  "PurchaseId": "string",
  "ContactName": "string",
  "PaymentDate": "string",
  "CheckNumber": "string",
  "PaymentAmount": "number",
  "OverpayBalance": "number",
  "RefundItems": "string",
  "ProcessorAlreadyIssued": "boolean",
  "ShowBalanceOption": "boolean",
  "BalanceOption": "string"
}

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/reinsertaccountingspreadmonthlyinvoicedate

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

POST /api/utils/rerunccsynchronizations/{fromdate}

String
fromdate: string
in path

(no description)

tenantid: string
in query

(no description)

Request Example
[
  {
    "this[]": "string",
    "Length": "integer"
  }
]
Response Example (200 OK)
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

GET /api/utils/rootmodel

Response Example (200 OK)
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

POST /api/utils/runmembershipcalculatepricesjob

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/runmembershiprenewals

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/runmigrations

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/sendassociationactivityrecapemail

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/sendeventreminders

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/sendfirstcontactpaymentnotification

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/sendnotificationforquickbookssyncerrorasync/{tenantid}

tenantid: integer
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/setpayrixepaymentfees/{tenantid}/{fromdate}

tenantid: string
in path

(no description)

fromdate: string
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/smscarriers

200 OK

OK

type
Response Example (200 OK)
[
  {
    "ID": "integer",
    "CountryCode": "string",
    "Name": "string",
    "GatewayFormat": "string"
  }
]

GET /api/utils/stateslist

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/utils/stateslist/{countryid}

countryid: string
in path

(no description)

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/utils/stateslist/default

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]

GET /api/utils/successplanprogress

Response Example (200 OK)
{
  "ItemProgress": "string",
  "OngoingSuccess": "string",
  "DiscoveryPercentage": "integer",
  "PlanningPercentage": "integer",
  "DesignPercentage": "integer",
  "LaunchPlanPercentage": "integer",
  "LaunchPercentage": "integer",
  "SuccessPercentage": "integer"
}

GET /api/utils/syncreportsrequiredmodules/{tenantid}

tenantid: string
in path

(no description)

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/syncvotervoice

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/unsubscribethirdpartysync

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/updateallsavedreports

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/updatefloodprotection

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/warmup

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

GET /api/utils/webcontentnotifications

OK

Response Example (200 OK)
{
  "ErrorMessages": "string"
}

Schema Definitions

ScreenApiInfo: object

Example
"object"

String: object

this[]: string
Length: integer
Example
{
  "this[]": "string",
  "Length": "integer"
}

HttpResponseMessage: object

Version: string
Content: string
StatusCode: string
ReasonPhrase: string
Headers: string
RequestMessage: string
IsSuccessStatusCode: boolean
Example
{
  "Version": "string",
  "Content": "string",
  "StatusCode": "string",
  "ReasonPhrase": "string",
  "Headers": "string",
  "RequestMessage": "string",
  "IsSuccessStatusCode": "boolean"
}

StandardJsonResult: object

ErrorMessages: string
Example
{
  "ErrorMessages": "string"
}

ValidateInputData: object

emailAddress: string
Example
{
  "emailAddress": "string"
}

CreateRefundModel: object

ChargeRefundAmount: string
PaymentRefundedAmount: string
AreAmountsDifferent: boolean
ShowChargeRefundAmountMessage: string
RefundDate: string
Notes: string
ContactId: integer
EPaymentTransactionId: string
PaymentId: integer
PurchaseId: string
ContactName: string
PaymentDate: string
CheckNumber: string
PaymentAmount: number
OverpayBalance: number
RefundItems: string
ProcessorAlreadyIssued: boolean
ShowBalanceOption: boolean
BalanceOption: string
Example
{
  "ChargeRefundAmount": "string",
  "PaymentRefundedAmount": "string",
  "AreAmountsDifferent": "boolean",
  "ShowChargeRefundAmountMessage": "string",
  "RefundDate": "string",
  "Notes": "string",
  "ContactId": "integer",
  "EPaymentTransactionId": "string",
  "PaymentId": "integer",
  "PurchaseId": "string",
  "ContactName": "string",
  "PaymentDate": "string",
  "CheckNumber": "string",
  "PaymentAmount": "number",
  "OverpayBalance": "number",
  "RefundItems": "string",
  "ProcessorAlreadyIssued": "boolean",
  "ShowBalanceOption": "boolean",
  "BalanceOption": "string"
}

GenericLookUpChoice<String>: object

Id: string
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Example
{
  "Id": "string",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer"
}

GenericLookUpChoice<Int32>: object

Id: integer
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer"
}

DashboardSuccessPlanScreen: object

ItemProgress: string
OngoingSuccess: string
DiscoveryPercentage: integer
PlanningPercentage: integer
DesignPercentage: integer
LaunchPlanPercentage: integer
LaunchPercentage: integer
SuccessPercentage: integer
Example
{
  "ItemProgress": "string",
  "OngoingSuccess": "string",
  "DiscoveryPercentage": "integer",
  "PlanningPercentage": "integer",
  "DesignPercentage": "integer",
  "LaunchPlanPercentage": "integer",
  "LaunchPercentage": "integer",
  "SuccessPercentage": "integer"
}

ListViewReturnModel<Object>: object

Criteria: string
CriteriaItems: string
TotalRecordAvailable: string

We typically only return a subset of what is available on the server, but lets show the user what was available

ModelItems: string
Results: string
Example
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

SmsCarrier: object

ID: integer
CountryCode: string
Name: string
GatewayFormat: string
Example
{
  "ID": "integer",
  "CountryCode": "string",
  "Name": "string",
  "GatewayFormat": "string"
}

Dictionary<String, ApiInfo>: object

Comparer: string
Count: integer
Keys: string
System.Collections.Generic.IDictionary<TKey,TValue>.Keys: string
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys: string
Values: string
System.Collections.Generic.IDictionary<TKey,TValue>.Values: string
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values: string
this[]: string
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly: boolean
System.Collections.ICollection.IsSynchronized: boolean
System.Collections.ICollection.SyncRoot: string
System.Collections.IDictionary.IsFixedSize: boolean
System.Collections.IDictionary.IsReadOnly: boolean
System.Collections.IDictionary.Keys: string
System.Collections.IDictionary.Values: string
System.Collections.IDictionary.Item: string
Example
{
  "Comparer": "string",
  "Count": "integer",
  "Keys": "string",
  "System.Collections.Generic.IDictionary<TKey,TValue>.Keys": "string",
  "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys": "string",
  "Values": "string",
  "System.Collections.Generic.IDictionary<TKey,TValue>.Values": "string",
  "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values": "string",
  "this[]": "string",
  "System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly": "boolean",
  "System.Collections.ICollection.IsSynchronized": "boolean",
  "System.Collections.ICollection.SyncRoot": "string",
  "System.Collections.IDictionary.IsFixedSize": "boolean",
  "System.Collections.IDictionary.IsReadOnly": "boolean",
  "System.Collections.IDictionary.Keys": "string",
  "System.Collections.IDictionary.Values": "string",
  "System.Collections.IDictionary.Item": "string"
}

Dictionary<HttpMethod, Int32>: object

Comparer: string
Count: integer
Keys: string
System.Collections.Generic.IDictionary<TKey,TValue>.Keys: string
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys: string
Values: string
System.Collections.Generic.IDictionary<TKey,TValue>.Values: string
System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values: string
this[]: integer
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly: boolean
System.Collections.ICollection.IsSynchronized: boolean
System.Collections.ICollection.SyncRoot: string
System.Collections.IDictionary.IsFixedSize: boolean
System.Collections.IDictionary.IsReadOnly: boolean
System.Collections.IDictionary.Keys: string
System.Collections.IDictionary.Values: string
System.Collections.IDictionary.Item: string
Example
{
  "Comparer": "string",
  "Count": "integer",
  "Keys": "string",
  "System.Collections.Generic.IDictionary<TKey,TValue>.Keys": "string",
  "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Keys": "string",
  "Values": "string",
  "System.Collections.Generic.IDictionary<TKey,TValue>.Values": "string",
  "System.Collections.Generic.IReadOnlyDictionary<TKey,TValue>.Values": "string",
  "this[]": "integer",
  "System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<TKey,TValue>>.IsReadOnly": "boolean",
  "System.Collections.ICollection.IsSynchronized": "boolean",
  "System.Collections.ICollection.SyncRoot": "string",
  "System.Collections.IDictionary.IsFixedSize": "boolean",
  "System.Collections.IDictionary.IsReadOnly": "boolean",
  "System.Collections.IDictionary.Keys": "string",
  "System.Collections.IDictionary.Values": "string",
  "System.Collections.IDictionary.Item": "string"
}

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}

GZ39999Class: object

key: string
TenantId: integer
JobIds: string
Example
{
  "key": "string",
  "TenantId": "integer",
  "JobIds": "string"
}