Custom endpoints for third parties to consume 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

ThirdParty

Get data for a specific Contact

GET /api/thirdparty/contacts/{contactid}

Get data for a specific Contact

contactid: integer
in path

Will return the data for specified ContactId

200 OK
ThirdPartyContactChangesModel

OK

Response Example (200 OK) 
{
  "ContactId": "integer",
  "Name": "string",
  "FirstName": "string",
  "LastName": "string",
  "LastModified": "string",
  "Created": "string",
  "Status": "string",
  "AccountNumber": "string",
  "ContactType": "string",
  "Title": "string",
  "InformalFirstName": "string",
  "Prefix": "string",
  "Suffix": "string",
  "MiddleName": "string",
  "Addresses": "string",
  "Phones": "string",
  "Emails": "string",
  "WebAddresses": "string",
  "CustomFields": "string",
  "PrimaryContactId": "integer",
  "PrimaryContactName": "string",
  "PrimaryContactFirstName": "string",
  "PrimaryContactLastName": "string",
  "PrimaryAccountNumber": "string",
  "PrimaryContactType": "string",
  "Memberships": "string"
}
ThirdParty

Get changes in the Contacts since a specified date

GET /api/thirdparty/contacts/getchangessince/{utcdatetime}

Get changes in the Contacts since a specified date

utcdatetime: string
in path

If getting changes to contacts since a certain date

options: string
in query

odata filter options - max result set size is 100

200 OK
ThirdPartyContactListModel

OK

Response Example (200 OK) 
{
  "Changes": "string",
  "NextPageDateParameter": "string"
}
ThirdParty

Get detailed data for specified purchase

GET /api/thirdparty/purchase/{purchaseid}

Get detailed data for specified purchase

purchaseid: integer
in path

Will return the data for specified PurchaseId

200 OK
ThirdPartyPurchaseModel

OK

Response Example (200 OK) 
{
  "PurchaseId": "integer",
  "ContactId": "integer",
  "InvoiceNumber": "string",
  "InvoiceDate": "string",
  "DueDate": "string",
  "Total": "number",
  "SubTotal": "number",
  "VoluntaryTotal": "number",
  "VoluntaryAmountPurchased": "number",
  "Balance": "number",
  "TaxAmount": "number",
  "DiscountTotal": "number",
  "ShippingAmount": "number",
  "PurchaseType": "string",
  "LineItems": "string",
  "Contacts": "string"
}

Schema Definitions

ThirdPartyContactListModel: object

Changes: string
NextPageDateParameter: string
Example
{
  "Changes": "string",
  "NextPageDateParameter": "string"
}

ThirdPartyContactChangesModel: object

ContactId: integer
Name: string
FirstName: string
LastName: string
LastModified: string
Created: string
Status: string
AccountNumber: string
ContactType: string
Title: string
InformalFirstName: string
Prefix: string
Suffix: string
MiddleName: string
Addresses: string
Phones: string
Emails: string
WebAddresses: string
CustomFields: string
PrimaryContactId: integer
PrimaryContactName: string
PrimaryContactFirstName: string
PrimaryContactLastName: string
PrimaryAccountNumber: string
PrimaryContactType: string
Memberships: string
Example
{
  "ContactId": "integer",
  "Name": "string",
  "FirstName": "string",
  "LastName": "string",
  "LastModified": "string",
  "Created": "string",
  "Status": "string",
  "AccountNumber": "string",
  "ContactType": "string",
  "Title": "string",
  "InformalFirstName": "string",
  "Prefix": "string",
  "Suffix": "string",
  "MiddleName": "string",
  "Addresses": "string",
  "Phones": "string",
  "Emails": "string",
  "WebAddresses": "string",
  "CustomFields": "string",
  "PrimaryContactId": "integer",
  "PrimaryContactName": "string",
  "PrimaryContactFirstName": "string",
  "PrimaryContactLastName": "string",
  "PrimaryAccountNumber": "string",
  "PrimaryContactType": "string",
  "Memberships": "string"
}

ThirdPartyPurchaseModel: object

PurchaseId: integer
ContactId: integer
InvoiceNumber: string
InvoiceDate: string
DueDate: string
Total: number
SubTotal: number
VoluntaryTotal: number
VoluntaryAmountPurchased: number
Balance: number
TaxAmount: number
DiscountTotal: number
ShippingAmount: number
PurchaseType: string
LineItems: string
Contacts: string
Example
{
  "PurchaseId": "integer",
  "ContactId": "integer",
  "InvoiceNumber": "string",
  "InvoiceDate": "string",
  "DueDate": "string",
  "Total": "number",
  "SubTotal": "number",
  "VoluntaryTotal": "number",
  "VoluntaryAmountPurchased": "number",
  "Balance": "number",
  "TaxAmount": "number",
  "DiscountTotal": "number",
  "ShippingAmount": "number",
  "PurchaseType": "string",
  "LineItems": "string",
  "Contacts": "string"
}
Documentation by Spectacle