The documenttemplate object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this documenttemplate |
BusinessId: Id required |
Document: string optional |
Name: string required |
TemplateOutputFormat: Nexudus.Coworking.Core.Enums.eDocumentTemplateFormat optional |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this documenttemplate |
SystemId: string optional api-only
User defined data about this documenttemplate. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"BusinessId": 12345678,
"Document": "Abc123456",
"Name": "Joe",
"TemplateOutputFormat": 1,
"UniqueId": "5694c523-ef41-41da-9af3-b68418c4f7fe",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a DocumentTemplate
This endpoint allows you to GET a list of documenttemplates based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/crm/documenttemplates?...
π Requires role "DocumentTemplate-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 documenttemplate records based on their different properties. |
Id number
?Id=12345678 |
DocumentTemplate_Business Business
?DocumentTemplate_Business=... |
DocumentTemplate_Document string
?DocumentTemplate_Document=... |
DocumentTemplate_Name string
?DocumentTemplate_Name=... |
DocumentTemplate_TemplateOutputFormat Nexudus.Coworking.Core.Enums.eDocumentTemplateFormat
?DocumentTemplate_TemplateOutputFormat=... |
DocumentTemplate_Business_Name string
?DocumentTemplate_Business_Name=... |
Range search querystring parameters
Lets you search documenttemplate records based on a range of date or numeric values. |
To_DocumentTemplate_CreatedOn date
?To_DocumentTemplate_CreatedOn=2010-01-01T20:32 |
From_DocumentTemplate_CreatedOn date
?From_DocumentTemplate_CreatedOn=2010-01-01T20:32 |
To_DocumentTemplate_UpdatedOn date
?To_DocumentTemplate_UpdatedOn=2010-01-01T20:32 |
From_DocumentTemplate_UpdatedOn date
?From_DocumentTemplate_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/crm/documenttemplates?DocumentTemplate_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"Document": "Abc123456",
"TemplateOutputFormat": 1,
"DocumentTemplateBusinessName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "9ff4c9b8-8d0c-4635-aac0-bdbd420c6a13",
"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 DocumentTemplates by IDs
Gets one or more documenttemplate records based on their Id.GET https://spaces.nexudus.com/api/crm/documenttemplates?DocumentTemplate_Id=[:id1,:id2,...]
π Requires role "DocumentTemplate-List"
Querystring parameters |
DocumentTemplate_Id: array requried
?DocumentTemplate_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/crm/documenttemplates?DocumentTemplate_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Business": ,
"Name": "Joe",
"Document": "Abc123456",
"TemplateOutputFormat": 1,
"DocumentTemplateBusinessName": "...",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "fd8e3050-ba38-4580-8320-bba6af008280",
"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 DocumentTemplate by Id
Gets one documenttemplate record by its Id.GET https://spaces.nexudus.com/api/crm/documenttemplates/:Id
π Requires role "DocumentTemplate-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/crm/documenttemplates/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"BusinessId": 12345678,
"Document": "Abc123456",
"Name": "Joe",
"TemplateOutputFormat": 1,
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "312b12be-ea8c-4b88-a755-1e43e2499be2",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new DocumentTemplate
Creates a new documenttemplate.POST https://spaces.nexudus.com/api/crm/documenttemplates
π Requires role "DocumentTemplate-Create"
Body parameters |
BusinessId: number required |
Name: string required |
Document: string optional |
TemplateOutputFormat: Nexudus.Coworking.Core.Enums.eDocumentTemplateFormat optional |
Example request
POST https://spaces.nexudus.com/api/crm/documenttemplates Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"BusinessId": 12345678,
"Name": "Joe",
"Document": "Abc123456",
"TemplateOutputFormat": 1, //(check Enumerated values section below)
}
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 DocumentTemplate
Updates an existing documenttemplate.PUT https://spaces.nexudus.com/api/crm/documenttemplates
PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.
π Requires role "DocumentTemplate-Edit"
Body parameters |
Id: number required
The unique Id of the documenttemplate to update. |
BusinessId: number cleared if missing |
Name: string cleared if missing |
Document: string cleared if missing |
TemplateOutputFormat: Nexudus.Coworking.Core.Enums.eDocumentTemplateFormat cleared if missing |
Example request
PUT https://spaces.nexudus.com/api/crm/documenttemplates Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Id": 12345678,
"BusinessId": 12345678,
"Name": "Joe",
"Document": "Abc123456",
"TemplateOutputFormat": 1, //(check Enumerated values section below)
}
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 DocumentTemplate
Deletes an existing documenttemplate by its Id.DELETE https://spaces.nexudus.com/api/crm/documenttemplates/:Id
π Requires role "DocumentTemplate-Delete"
URL parameters |
Id: number required
The unique Id of the documenttemplate to update. |
Example request
DELETE https://spaces.nexudus.com/api/crm/documenttemplates/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 documenttemplate 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 documenttemplate records.GET https://spaces.nexudus.com/api/crm/documenttemplates/commands
Example request
GET https://spaces.nexudus.com/api/crm/documenttemplates/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 documenttemplate record IDs.POST https://spaces.nexudus.com/api/crm/documenttemplates/runacommandπ Requires role "DocumentTemplate-Edit"
Example request
POST https://spaces.nexudus.com/api/crm/documenttemplates/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
}
Enumerated values
TemplateOutputFormat
GET /api/utils/enums?name=eDocumentTemplateFormat
Binary files
The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.
BinaryDocument
GET https://spaces.nexudus.com/api/crm/documenttemplates/getbinarydocument/:id
URL parameters |
Id: number required
The id of the DocumentTemplate to get the binarydocument for. |
Comments
Please sign in to leave a comment.