The reseller object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this reseller |
AgreedTermsOn: DateTime? optional read-only |
Approved: bool optional read-only |
Area: string optional |
AutoApprovePayouts: bool optional read-only |
CurrencyId: Id required read-only |
Email: string optional |
Name: string required |
NextPayoutDate: DateTime? optional read-only |
OperatesIn: string optional |
PhoneNumber: string optional |
ProfileIsPublic: bool optional |
ProfileSummary: string optional |
StripeAccountId: string optional read-only |
Testimonial1: string optional |
Testimonial1Author: string optional |
Testimonial2: string optional |
Testimonial2Author: string optional |
UserId: Id required read-only |
WebAddress: string optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this reseller |
SystemId: string optional api-only
User defined data about this reseller. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"AgreedTermsOn": ,
"Approved": false,
"Area": "00001",
"AutoApprovePayouts": false,
"CurrencyId": 12345678,
"Email": "00001",
"Name": "00001",
"NextPayoutDate": ,
"OperatesIn": "00001",
"PhoneNumber": "BusinessArea",
"ProfileIsPublic": false,
"ProfileSummary": "BusinessArea",
"StripeAccountId": "false",
"Testimonial1": "BusinessArea",
"Testimonial1Author": "BusinessArea",
"Testimonial2": "BusinessArea",
"Testimonial2Author": "BusinessArea",
"UserId": 12345678,
"WebAddress": "00001",
"UniqueId": "15628ab3-a7b0-4b2a-8750-cfb37ec21fd6",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a Reseller
This endpoint allows you to GET a list of resellers based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/sys/resellers?...
π Requires role "Reseller-List"
Pagination querystring parameters
Lets control how many records to return at a time and their order. |
page integer optional
?page=1 |
size integer optional default=25
Sets the maximum number of records to return each page of results. ?size=25 |
orderby string optional default=Id
Sets the property to use when ordering the results of the search. ?orderby=Id |
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records. ?sort=ascending |
Search querystring parameters
Lets you search reseller records based on their different properties. |
Id number
?Id=12345678 |
Reseller_AgreedTermsOn DateTime?
?Reseller_AgreedTermsOn=... |
Reseller_Approved bool
?Reseller_Approved=... |
Reseller_Area string
?Reseller_Area=... |
Reseller_AutoApprovePayouts bool
?Reseller_AutoApprovePayouts=... |
Reseller_Currency Currency
?Reseller_Currency=... |
Reseller_Email string
?Reseller_Email=... |
Reseller_Name string
?Reseller_Name=... |
Reseller_NextPayoutDate DateTime?
?Reseller_NextPayoutDate=... |
Reseller_OperatesIn string
?Reseller_OperatesIn=... |
Reseller_PhoneNumber string
?Reseller_PhoneNumber=... |
Reseller_ProfileIsPublic bool
?Reseller_ProfileIsPublic=... |
Reseller_ProfileSummary string
?Reseller_ProfileSummary=... |
Reseller_StripeAccountId string
?Reseller_StripeAccountId=... |
Reseller_Testimonial1 string
?Reseller_Testimonial1=... |
Reseller_Testimonial1Author string
?Reseller_Testimonial1Author=... |
Reseller_Testimonial2 string
?Reseller_Testimonial2=... |
Reseller_Testimonial2Author string
?Reseller_Testimonial2Author=... |
Reseller_User User
?Reseller_User=... |
Reseller_WebAddress string
?Reseller_WebAddress=... |
Reseller_User_FullName string
?Reseller_User_FullName=... |
Reseller_User_Email string
?Reseller_User_Email=... |
Reseller_Currency_Code string
?Reseller_Currency_Code=... |
Range search querystring parameters
Lets you search reseller records based on a range of date or numeric values. |
To_Reseller_CreatedOn date
?To_Reseller_CreatedOn=2010-01-01T20:32 |
From_Reseller_CreatedOn date
?From_Reseller_CreatedOn=2010-01-01T20:32 |
To_Reseller_UpdatedOn date
?To_Reseller_UpdatedOn=2010-01-01T20:32 |
From_Reseller_UpdatedOn date
?From_Reseller_UpdatedOn=2010-01-01T20:32 |
To_Reseller_AgreedTermsOn date
?To_Reseller_AgreedTermsOn=2010-01-01T20:32 |
From_Reseller_AgreedTermsOn date
?From_Reseller_AgreedTermsOn=2010-01-01T20:32 |
To_Reseller_NextPayoutDate date
?To_Reseller_NextPayoutDate=2010-01-01T20:32 |
From_Reseller_NextPayoutDate date
?From_Reseller_NextPayoutDate=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/sys/resellers?Reseller_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "00001",
"User": ,
"Currency": ,
"AgreedTermsOn": ,
"Approved": false,
"AutoApprovePayouts": false,
"NextPayoutDate": ,
"ProfileIsPublic": false,
"Area": "00001",
"OperatesIn": "00001",
"WebAddress": "00001",
"Email": "00001",
"ProfileSummary": "BusinessArea",
"PhoneNumber": "BusinessArea",
"Testimonial1": "BusinessArea",
"Testimonial1Author": "BusinessArea",
"Testimonial2": "BusinessArea",
"Testimonial2Author": "BusinessArea",
"StripeAccountId": "false",
"ResellerUserFullName": "...",
"ResellerUserEmail": "...",
"ResellerCurrencyCode": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "2c284186-f296-4000-9bd4-7aba006eb351",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 25,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 60,
"TotalPages": 3
}
Find Resellers by IDs
Gets one or more reseller records based on their Id.GET https://spaces.nexudus.com/api/sys/resellers?Reseller_Id=[:id1,:id2,...]
π Requires role "Reseller-List"
Querystring parameters |
Reseller_Id: array requried
?Reseller_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/sys/resellers?Reseller_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "00001",
"User": ,
"Currency": ,
"AgreedTermsOn": ,
"Approved": false,
"AutoApprovePayouts": false,
"NextPayoutDate": ,
"ProfileIsPublic": false,
"Area": "00001",
"OperatesIn": "00001",
"WebAddress": "00001",
"Email": "00001",
"ProfileSummary": "BusinessArea",
"PhoneNumber": "BusinessArea",
"Testimonial1": "BusinessArea",
"Testimonial1Author": "BusinessArea",
"Testimonial2": "BusinessArea",
"Testimonial2Author": "BusinessArea",
"StripeAccountId": "false",
"ResellerUserFullName": "...",
"ResellerUserEmail": "...",
"ResellerCurrencyCode": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "3d7d7496-e573-4afe-a6e8-0b6b50b20ef0",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}],
"CurrentPageSize": 25,
"CurrentPage": 1,
"CurrentOrderField": "Id",
"CurrentSortDirection": 1,
"FirstItem": 1,
"HasNextPage": true,
"HasPreviousPage": false,
"LastItem": 1,
"PageNumber": 1,
"PageSize": 25,
"TotalItems": 1,
"TotalPages": 1
}
Get single Reseller by Id
Gets one reseller record by its Id.GET https://spaces.nexudus.com/api/sys/resellers/:Id
π Requires role "Reseller-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/sys/resellers/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"AgreedTermsOn": ,
"Approved": false,
"Area": "00001",
"AutoApprovePayouts": false,
"CurrencyId": 12345678,
"Email": "00001",
"Name": "00001",
"NextPayoutDate": ,
"OperatesIn": "00001",
"PhoneNumber": "BusinessArea",
"ProfileIsPublic": false,
"ProfileSummary": "BusinessArea",
"StripeAccountId": "false",
"Testimonial1": "BusinessArea",
"Testimonial1Author": "BusinessArea",
"Testimonial2": "BusinessArea",
"Testimonial2Author": "BusinessArea",
"UserId": 12345678,
"WebAddress": "00001",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "0d47c021-5025-49e7-8606-d2c5248104ca",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new Reseller
Creates a new reseller.POST https://spaces.nexudus.com/api/sys/resellers
π Requires role "Reseller-Create"
Body parameters |
Name: string required |
ProfileIsPublic: bool optional |
Area: string optional |
OperatesIn: string optional |
WebAddress: string optional |
Email: string optional |
ProfileSummary: string optional |
PhoneNumber: string optional |
Testimonial1: string optional |
Testimonial1Author: string optional |
Testimonial2: string optional |
Testimonial2Author: string optional |
Example request
POST https://spaces.nexudus.com/api/sys/resellers Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Name": "00001",
"ProfileIsPublic": false,
"Area": "00001",
"OperatesIn": "00001",
"WebAddress": "00001",
"Email": "00001",
"ProfileSummary": "BusinessArea",
"PhoneNumber": "BusinessArea",
"Testimonial1": "BusinessArea",
"Testimonial1Author": "BusinessArea",
"Testimonial2": "BusinessArea",
"Testimonial2Author": "BusinessArea",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully created.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Update Reseller
Updates an existing reseller.PUT https://spaces.nexudus.com/api/sys/resellers
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "Reseller-Edit"
Body parameters |
Id: number required
The unique Id of the reseller to update. |
Name: string cleared if missing |
ProfileIsPublic: bool cleared if missing |
Area: string cleared if missing |
OperatesIn: string cleared if missing |
WebAddress: string cleared if missing |
Email: string cleared if missing |
ProfileSummary: string cleared if missing |
PhoneNumber: string cleared if missing |
Testimonial1: string cleared if missing |
Testimonial1Author: string cleared if missing |
Testimonial2: string cleared if missing |
Testimonial2Author: string cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/sys/resellers Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"Name": "00001",
"ProfileIsPublic": false,
"Area": "00001",
"OperatesIn": "00001",
"WebAddress": "00001",
"Email": "00001",
"ProfileSummary": "BusinessArea",
"PhoneNumber": "BusinessArea",
"Testimonial1": "BusinessArea",
"Testimonial1Author": "BusinessArea",
"Testimonial2": "BusinessArea",
"Testimonial2Author": "BusinessArea",
}
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "Record 'Name of the record' has been succesfully updated.",
"Value": {
"Id": 12354678
}
}
Example invalid response
{
"Status": 500,
"Message": "Name: may not be null or empty",
"Value": null,
"WasSuccessful": false,
"Errors": [
{
"AttemptedValue": null,
"Message": "may not be null or empty",
"PropertyName": "Name"
},
]
}
Delete Reseller
Deletes an existing reseller by its Id.DELETE https://spaces.nexudus.com/api/sys/resellers/:Id
π Requires role "Reseller-Delete"
URL parameters |
Id: number required
The unique Id of the reseller to update. |
Example request
DELETE https://spaces.nexudus.com/api/sys/resellers/12345678 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
{
"Status": 200,
"WasSuccessful": true,
"Message": "The record was deleted successfully.",
"Value": null,
"OpenInDialog": false,
"RedirectURL": null,
"JavaScript": null,
"Errors": null
}
Commands
Commands allow to perform actions against one or more reseller records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.Get Commands
Get all commands available to run for reseller records.GET https://spaces.nexudus.com/api/sys/resellers/commands
Example request
GET https://spaces.nexudus.com/api/sys/resellers/commands Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example valid response
[
{
"Key": "COMMAND_KEY_1",
"Name": "Command 1 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": false,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": false,
"NeedsEntitiesToRun": true,
"Order": 2,
"RequiresParameters": []
},
{
"Key": "COMMAND_KEY_2",
"Name": "Command 2 english description",
"AppliesOnlyToMultipleEntities": false,
"DisplayInDropdown": true,
"DisplayInDropdownV2": true,
"AppliesOnlyToOneEntity": true,
"AppliesOnlyToTwoEntities": false,
"DisplayInGrid": true,
"NeedsEntitiesToRun": true,
"Order": 10,
"RequiresParameters":
[
{
"Name": "Parameter 1 description",
"Type": "string",
},
{
"Name": "Parameter 2 description",
"Type": "Boolean",
}
]
},
...
]
Run Command
Runs a command based on its Key and one or more reseller record IDs.POST https://spaces.nexudus.com/api/sys/resellers/runacommandπ Requires role "Reseller-Edit"
Example request
POST https://spaces.nexudus.com/api/sys/resellers/runcommand Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Ids":[1329961649],
"Parameters":
[
{
"Type": "string"
"Value":987654321
},
{
"Type": "Boolean",
"Value":true
},
...
],
"Key":"COMMAND_KEY_2"
}
Example valid response
{
"Errors": null
"JavaScript": null
"Message": "Result description"
"OpenInDialog": false
"OpenInWindow": false
"RedirectURL": null
"Status": 200
"UpdatedBy": "email@example.net"
"UpdatedOn: "2020-06-04T11:40:20Z"
"Value: {Id: 12345678}
"WasSuccessful: true
}
Binary files
The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.
Avatar
GET https://spaces.nexudus.com/api/sys/resellers/getavatar/:id
URL parameters |
Id: number required
The id of the Reseller to get the avatar for. |
Logo
GET https://spaces.nexudus.com/api/sys/resellers/getlogo/:id
URL parameters |
Id: number required
The id of the Reseller to get the logo for. |
Comments
Please sign in to leave a comment.