Reference

Coworkerdelivery

The coworkerdelivery object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this coworkerdelivery
BusinessId: Id required
Collected: bool optional
CoworkerId: Id optional
Location: string required
Name: string required
Notes: string optional
Processed: bool optional read-only
ReceivedBy: string optional
RequiresSignature: bool optional
Signed: bool optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this coworkerdelivery
SystemId: string optional api-only
User defined data about this coworkerdelivery. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Collected": false,
  "CoworkerId": 12345678,
  "Location": "00001",
  "Name": "00001",
  "Notes": "Abc123456",
  "Processed": false,
  "ReceivedBy": "00001",
  "RequiresSignature": false,
  "Signed": false,
  "UniqueId": "0e824a50-ccb7-44c1-88fb-36bbe7da1a9b",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CoworkerDelivery

This endpoint allows you to GET a list of coworkerdeliveries based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries?...

πŸ”’ Requires role "CoworkerDelivery-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 coworkerdelivery records based on their different properties.
Id number
?Id=12345678
CoworkerDelivery_Business Business
?CoworkerDelivery_Business=...
CoworkerDelivery_Collected bool
?CoworkerDelivery_Collected=...
CoworkerDelivery_Coworker Coworker
?CoworkerDelivery_Coworker=...
CoworkerDelivery_Location string
?CoworkerDelivery_Location=...
CoworkerDelivery_Name string
?CoworkerDelivery_Name=...
CoworkerDelivery_Notes string
?CoworkerDelivery_Notes=...
CoworkerDelivery_Processed bool
?CoworkerDelivery_Processed=...
CoworkerDelivery_ReceivedBy string
?CoworkerDelivery_ReceivedBy=...
CoworkerDelivery_RequiresSignature bool
?CoworkerDelivery_RequiresSignature=...
CoworkerDelivery_Signed bool
?CoworkerDelivery_Signed=...
CoworkerDelivery_CoworkerFullName string
?CoworkerDelivery_CoworkerFullName=...
CoworkerDelivery_CoworkerEmail string
?CoworkerDelivery_CoworkerEmail=...
CoworkerDelivery_CoworkerBillingName string
?CoworkerDelivery_CoworkerBillingName=...
CoworkerDelivery_CoworkerCompanyName string
?CoworkerDelivery_CoworkerCompanyName=...

Range search querystring parameters
Lets you search coworkerdelivery records based on a range of date or numeric values.
To_CoworkerDelivery_CreatedOn date
?To_CoworkerDelivery_CreatedOn=2010-01-01T20:32
From_CoworkerDelivery_CreatedOn date
?From_CoworkerDelivery_CreatedOn=2010-01-01T20:32
To_CoworkerDelivery_UpdatedOn date
?To_CoworkerDelivery_UpdatedOn=2010-01-01T20:32
From_CoworkerDelivery_UpdatedOn date
?From_CoworkerDelivery_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries?CoworkerDelivery_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "Name": "00001",
        "Location": "00001",
        "ReceivedBy": "00001",
        "Notes": "Abc123456",
        "Processed": false,
        "Collected": false,
        "RequiresSignature": false,
        "Signed": false,
        "CoworkerDeliveryCoworkerFullName": "...",
        "CoworkerDeliveryCoworkerEmail": "...",
        "CoworkerDeliveryCoworkerBillingName": "...",
        "CoworkerDeliveryCoworkerCompanyName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c8dcf03c-6e98-481d-8f38-6eef1bde5c91",
        "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 CoworkerDeliveries by IDs

Gets one or more coworkerdelivery records based on their Id.
GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries?CoworkerDelivery_Id=[:id1,:id2,...]

πŸ”’ Requires role "CoworkerDelivery-List"

Querystring parameters
CoworkerDelivery_Id: array requried
?CoworkerDelivery_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries?CoworkerDelivery_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Coworker": ,
        "Name": "00001",
        "Location": "00001",
        "ReceivedBy": "00001",
        "Notes": "Abc123456",
        "Processed": false,
        "Collected": false,
        "RequiresSignature": false,
        "Signed": false,
        "CoworkerDeliveryCoworkerFullName": "...",
        "CoworkerDeliveryCoworkerEmail": "...",
        "CoworkerDeliveryCoworkerBillingName": "...",
        "CoworkerDeliveryCoworkerCompanyName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "36db8ec8-9756-44f5-8370-d5b0fc07d250",
        "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 CoworkerDelivery by Id

Gets one coworkerdelivery record by its Id.
GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries/:Id

πŸ”’ Requires role "CoworkerDelivery-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Collected": false,
  "CoworkerId": 12345678,
  "Location": "00001",
  "Name": "00001",
  "Notes": "Abc123456",
  "Processed": false,
  "ReceivedBy": "00001",
  "RequiresSignature": false,
  "Signed": false,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "9d44a12e-4ec0-43bf-8c98-1c71f59b5837",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CoworkerDelivery

Creates a new coworkerdelivery.
POST https://spaces.nexudus.com/api/spaces/coworkerdeliveries

πŸ”’ Requires role "CoworkerDelivery-Create"

Body parameters
BusinessId: number required
CoworkerId: number optional
Name: string required
Location: string required
ReceivedBy: string optional
Notes: string optional
Collected: bool optional
RequiresSignature: bool optional
Signed: bool optional

Example request

POST https://spaces.nexudus.com/api/spaces/coworkerdeliveries
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "Location": "00001",
    "ReceivedBy": "00001",
    "Notes": "Abc123456",
    "Collected": false,
    "RequiresSignature": false,
    "Signed": false,
}


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 CoworkerDelivery

Updates an existing coworkerdelivery.
PUT https://spaces.nexudus.com/api/spaces/coworkerdeliveries

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "CoworkerDelivery-Edit"

Body parameters
Id: number required
The unique Id of the coworkerdelivery to update.
BusinessId: number cleared if missing
CoworkerId: number cleared if missing
Name: string cleared if missing
Location: string cleared if missing
ReceivedBy: string cleared if missing
Notes: string cleared if missing
Collected: bool cleared if missing
RequiresSignature: bool cleared if missing
Signed: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/spaces/coworkerdeliveries
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "CoworkerId": 12345678,
    "Name": "00001",
    "Location": "00001",
    "ReceivedBy": "00001",
    "Notes": "Abc123456",
    "Collected": false,
    "RequiresSignature": false,
    "Signed": false,
}


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 CoworkerDelivery

Deletes an existing coworkerdelivery by its Id.
DELETE https://spaces.nexudus.com/api/spaces/coworkerdeliveries/:Id

πŸ”’ Requires role "CoworkerDelivery-Delete"

URL parameters
Id: number required
The unique Id of the coworkerdelivery to update.

Example request

DELETE https://spaces.nexudus.com/api/spaces/coworkerdeliveries/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 coworkerdelivery 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 coworkerdelivery records.
GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries/commands

Example request

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries/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 coworkerdelivery record IDs.
POST https://spaces.nexudus.com/api/spaces/coworkerdeliveries/runacommand
πŸ”’ Requires role "CoworkerDelivery-Edit"

Example request

POST https://spaces.nexudus.com/api/spaces/coworkerdeliveries/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.

FileData

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries/getfiledata/:id
URL parameters
Id: number required
The id of the CoworkerDelivery to get the filedata for.

Signature

GET https://spaces.nexudus.com/api/spaces/coworkerdeliveries/getsignature/:id
URL parameters
Id: number required
The id of the CoworkerDelivery to get the signature for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.