Vendor Resource¶
Get Vendor¶
HTTP Request
GET /api/vendors/{id}
📋 Description: Retrieves detailed information about a specific vendor identified by the provided ID, enabling users to access essential vendor data for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "address": "string",
9 "contractEndDate": "2019-08-24",
10 "services": "string",
11 "vendorType": "string",
12 "vendorStatusId": 0,
13 "vendorStatus": "string",
14 "vendorStatusType": "string",
15 "businessTypeId": 0,
16 "businessType": "string",
17 "vendorRateId": 0,
18 "vendorRate": "string",
19 "vendorContactIds": [
20 0
21 ],
22 "premiseIds": [
23 0
24 ],
25 "firstPremiseDisplayId": "string",
26 "ownerUserName": "string",
27 "ownerDto": {
28 "id": 0,
29 "createdBy": "string",
30 "createdAt": "2019-08-24T14:15:22Z",
31 "userName": "string",
32 "firstName": "string",
33 "lastName": "string",
34 "email": "string",
35 "roleIds": [
36 {
37 "id": 0,
38 "createdBy": "string",
39 "createdAt": "2019-08-24T14:15:22Z",
40 "modifiedBy": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z",
42 "roleName": "string",
43 "entity": "string",
44 "new": true
45 }
46 ],
47 "internalTeamNames": [
48 "string"
49 ],
50 "internalTeamIds": [
51 0
52 ],
53 "internalTeamDisplayIds": [
54 "string"
55 ],
56 "premiseIds": [
57 0
58 ],
59 "premiseNames": [
60 "string"
61 ],
62 "userAvailable": true,
63 "temporaryWorkload": 0,
64 "preferredCultureCode": "string"
65 },
66 "vendorAvailable": true,
67 "vendorRating": 0.1,
68 "premiseDisplayIds": [
69 "string"
70 ]
71}
Update Vendor¶
HTTP Request
PUT /api/vendors/{id}
📋 Description: Updates the details of a specific vendor identified by the unique {id}, allowing for modifications to vendor information to ensure accuracy and relevance in business operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated vendor information, including name, contact details, and service offerings, to ensure accurate vendor management. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "address": "string",
9 "contractEndDate": "2019-08-24",
10 "services": "string",
11 "vendorType": "string",
12 "vendorStatusId": 0,
13 "vendorStatus": "string",
14 "vendorStatusType": "string",
15 "businessTypeId": 0,
16 "businessType": "string",
17 "vendorRateId": 0,
18 "vendorRate": "string",
19 "vendorContactIds": [
20 0
21 ],
22 "premiseIds": [
23 0
24 ],
25 "firstPremiseDisplayId": "string",
26 "ownerUserName": "string",
27 "ownerDto": {
28 "id": 0,
29 "createdBy": "string",
30 "createdAt": "2019-08-24T14:15:22Z",
31 "userName": "string",
32 "firstName": "string",
33 "lastName": "string",
34 "email": "string",
35 "roleIds": [
36 {
37 "id": 0,
38 "createdBy": "string",
39 "createdAt": "2019-08-24T14:15:22Z",
40 "modifiedBy": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z",
42 "roleName": "string",
43 "entity": "string",
44 "new": true
45 }
46 ],
47 "internalTeamNames": [
48 "string"
49 ],
50 "internalTeamIds": [
51 0
52 ],
53 "internalTeamDisplayIds": [
54 "string"
55 ],
56 "premiseIds": [
57 0
58 ],
59 "premiseNames": [
60 "string"
61 ],
62 "userAvailable": true,
63 "temporaryWorkload": 0,
64 "preferredCultureCode": "string"
65 },
66 "vendorAvailable": true,
67 "vendorRating": 0.1,
68 "premiseDisplayIds": [
69 "string"
70 ]
71}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Vendor¶
HTTP Request
DELETE /api/vendors/{id}
📋 Description: Deletes a vendor identified by the specified ID, ensuring the removal of associated records from the system to maintain accurate vendor management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Vendor¶
HTTP Request
GET /api/vendors
📋 Description: Retrieves a list of registered vendors, providing essential details for vendor management and selection processes.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "description": "string",
9 "address": "string",
10 "contractEndDate": "2019-08-24",
11 "services": "string",
12 "vendorType": "string",
13 "vendorStatusId": 0,
14 "vendorStatus": "string",
15 "vendorStatusType": "string",
16 "businessTypeId": 0,
17 "businessType": "string",
18 "vendorRateId": 0,
19 "vendorRate": "string",
20 "vendorContactIds": [
21 0
22 ],
23 "premiseIds": [
24 0
25 ],
26 "firstPremiseDisplayId": "string",
27 "ownerUserName": "string",
28 "ownerDto": {
29 "id": 0,
30 "createdBy": "string",
31 "createdAt": "2019-08-24T14:15:22Z",
32 "userName": "string",
33 "firstName": "string",
34 "lastName": "string",
35 "email": "string",
36 "roleIds": [
37 {
38 "id": 0,
39 "createdBy": "string",
40 "createdAt": "2019-08-24T14:15:22Z",
41 "modifiedBy": "string",
42 "modifiedAt": "2019-08-24T14:15:22Z",
43 "roleName": "string",
44 "entity": "string",
45 "new": true
46 }
47 ],
48 "internalTeamNames": [
49 "string"
50 ],
51 "internalTeamIds": [
52 0
53 ],
54 "internalTeamDisplayIds": [
55 "string"
56 ],
57 "premiseIds": [
58 0
59 ],
60 "premiseNames": [
61 "string"
62 ],
63 "userAvailable": true,
64 "temporaryWorkload": 0,
65 "preferredCultureCode": "string"
66 },
67 "vendorAvailable": true,
68 "vendorRating": 0.1,
69 "premiseDisplayIds": [
70 "string"
71 ]
72 }
73]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a vendor, encapsulating essential details such as vendor identification, contact information, and service offerings to facilitate effective supplier management and collaboration.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
false |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» address |
string |
false |
none |
Represents the physical location of the vendor, essential for logistical coordination and service delivery. |
» contractEndDate |
string(date) |
false |
none |
Date of the contract end |
» services |
string |
false |
none |
Represents the list of services offered by the vendor, essential for evaluating vendor capabilities and aligning them with business needs. |
» vendorType |
string |
false |
none |
Type of the vendor |
» vendorStatusId |
integer(int64) |
false |
none |
Unique identifier for the vendor status |
» vendorStatus |
string |
false |
none |
Status of the vendor |
» vendorStatusType |
string |
false |
none |
Type of the vendor status |
» businessTypeId |
integer(int64) |
false |
none |
Unique identifier for the business type |
» businessType |
string |
false |
none |
Type of the business |
» vendorRateId |
integer(int64) |
false |
none |
Unique identifier for the vendor rate |
» vendorRate |
string |
false |
none |
Rate of vendor |
» vendorContactIds |
[integer] |
false |
none |
Array of unique identifiers for vendor contacts associated with the vendor, facilitating streamlined communication and management of vendor relationships. |
» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the vendor, facilitating streamlined management and tracking of vendor relationships. |
» firstPremiseDisplayId |
string |
false |
none |
Unique identifier for the first premise display |
» ownerUserName |
string |
false |
none |
Name of the owner user |
» ownerDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» userName |
string |
false |
none |
Name of the user |
»» firstName |
string |
false |
none |
Name of the first |
»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»» roleName |
string |
false |
none |
Name of the role |
»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
» vendorAvailable |
boolean |
false |
none |
Indicates whether the vendor is currently available for new engagements. |
» vendorRating |
number(double) |
false |
none |
Numeric representation of the vendor’s performance rating, used to assess and compare vendor quality within the procurement process. |
» premiseDisplayIds |
[string] |
false |
none |
Array of unique identifiers for the premises associated with the vendor, facilitating streamlined management and reference within the system. |
Create Vendor¶
HTTP Request
POST /api/vendors
📋 Description: Creates a new vendor record in the system, enabling businesses to manage vendor relationships and streamline procurement processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the vendor information, including name, contact details, and business classification, necessary for vendor registration. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "address": "string",
9 "contractEndDate": "2019-08-24",
10 "services": "string",
11 "vendorType": "string",
12 "vendorStatusId": 0,
13 "vendorStatus": "string",
14 "vendorStatusType": "string",
15 "businessTypeId": 0,
16 "businessType": "string",
17 "vendorRateId": 0,
18 "vendorRate": "string",
19 "vendorContactIds": [
20 0
21 ],
22 "premiseIds": [
23 0
24 ],
25 "firstPremiseDisplayId": "string",
26 "ownerUserName": "string",
27 "ownerDto": {
28 "id": 0,
29 "createdBy": "string",
30 "createdAt": "2019-08-24T14:15:22Z",
31 "userName": "string",
32 "firstName": "string",
33 "lastName": "string",
34 "email": "string",
35 "roleIds": [
36 {
37 "id": 0,
38 "createdBy": "string",
39 "createdAt": "2019-08-24T14:15:22Z",
40 "modifiedBy": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z",
42 "roleName": "string",
43 "entity": "string",
44 "new": true
45 }
46 ],
47 "internalTeamNames": [
48 "string"
49 ],
50 "internalTeamIds": [
51 0
52 ],
53 "internalTeamDisplayIds": [
54 "string"
55 ],
56 "premiseIds": [
57 0
58 ],
59 "premiseNames": [
60 "string"
61 ],
62 "userAvailable": true,
63 "temporaryWorkload": 0,
64 "preferredCultureCode": "string"
65 },
66 "vendorAvailable": true,
67 "vendorRating": 0.1,
68 "premiseDisplayIds": [
69 "string"
70 ]
71}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "address": "string",
9 "contractEndDate": "2019-08-24",
10 "services": "string",
11 "vendorType": "string",
12 "vendorStatusId": 0,
13 "vendorStatus": "string",
14 "vendorStatusType": "string",
15 "businessTypeId": 0,
16 "businessType": "string",
17 "vendorRateId": 0,
18 "vendorRate": "string",
19 "vendorContactIds": [
20 0
21 ],
22 "premiseIds": [
23 0
24 ],
25 "firstPremiseDisplayId": "string",
26 "ownerUserName": "string",
27 "ownerDto": {
28 "id": 0,
29 "createdBy": "string",
30 "createdAt": "2019-08-24T14:15:22Z",
31 "userName": "string",
32 "firstName": "string",
33 "lastName": "string",
34 "email": "string",
35 "roleIds": [
36 {
37 "id": 0,
38 "createdBy": "string",
39 "createdAt": "2019-08-24T14:15:22Z",
40 "modifiedBy": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z",
42 "roleName": "string",
43 "entity": "string",
44 "new": true
45 }
46 ],
47 "internalTeamNames": [
48 "string"
49 ],
50 "internalTeamIds": [
51 0
52 ],
53 "internalTeamDisplayIds": [
54 "string"
55 ],
56 "premiseIds": [
57 0
58 ],
59 "premiseNames": [
60 "string"
61 ],
62 "userAvailable": true,
63 "temporaryWorkload": 0,
64 "preferredCultureCode": "string"
65 },
66 "vendorAvailable": true,
67 "vendorRating": 0.1,
68 "premiseDisplayIds": [
69 "string"
70 ]
71}
Get All Vendor Contacts By Vendor ID¶
HTTP Request
GET /api/vendors/{id}/vendorContacts
📋 Description: Retrieves the list of vendor contacts associated with a specified vendor, enabling efficient management of vendor relationships and communication.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "designation": "string",
8 "phone": "string",
9 "email": "string",
10 "vendorId": 0,
11 "vendorDisplayId": "string",
12 "originalName": "string"
13 }
14]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the contact information and details of a vendor, facilitating effective communication and relationship management within the vendor management system.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» designation |
string |
false |
none |
Represents the job title or role of the vendor contact within their organization, facilitating effective communication and relationship management. |
» phone |
string |
false |
none |
Contact phone number for the vendor, facilitating direct communication and support. |
string |
false |
none |
Email address of the vendor contact, used for communication and correspondence related to vendor management. |
|
» vendorId |
integer(int64) |
false |
none |
Unique identifier for the vendor |
» vendorDisplayId |
string |
false |
none |
Unique identifier for the vendor display |
» originalName |
string |
false |
none |
Name of the original |
Create Vendor Contacts By Vendor¶
HTTP Request
POST /api/vendors/{id}/vendorContacts
📋 Description: Creates a new vendor contact associated with the specified vendor ID, enabling effective communication and relationship management within the vendor ecosystem.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the vendor contact information, including name, email, phone number, and role, essential for managing vendor relationships effectively. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "designation": "string",
7 "phone": "string",
8 "email": "string",
9 "vendorId": 0,
10 "vendorDisplayId": "string",
11 "originalName": "string"
12}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Get Vendor Contact By ID¶
HTTP Request
GET /api/vendors/{id}/vendorContacts/{contactId}
📋 Description: Retrieves detailed information about a specific vendor contact associated with the given vendor ID, facilitating effective vendor management and communication.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
contactId |
path |
integer(int64) |
true |
Unique identifier for the contact |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "designation": "string",
7 "phone": "string",
8 "email": "string",
9 "vendorId": 0,
10 "vendorDisplayId": "string",
11 "originalName": "string"
12}
Update Vendor Contact¶
HTTP Request
POST /api/vendors/{id}/vendorContacts/{contactId}
📋 Description: Creates or updates a vendor contact for the specified vendor, ensuring accurate and up-to-date contact information is maintained within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
contactId |
path |
integer(int64) |
true |
Unique identifier for the contact |
body |
body |
true |
Request body containing the updated contact information for the specified vendor, including name, email, phone number, and role. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "designation": "string",
7 "phone": "string",
8 "email": "string",
9 "vendorId": 0,
10 "vendorDisplayId": "string",
11 "originalName": "string"
12}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Attach Asset Part To Vendor¶
HTTP Request
POST /api/vendors/{id}/assetParts/{assetPartId}
📋 Description: Creates a new asset part for the specified vendor, enabling efficient management and tracking of vendor-related assets.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetPartId |
path |
integer(int64) |
true |
Unique identifier for the asset part |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Detach Asset Parts By Main Asset¶
HTTP Request
DELETE /api/vendors/{id}/assetParts/{assetPartId}
📋 Description: Deletes a specific asset part associated with a vendor, ensuring the removal of outdated or unnecessary components from the vendor’s asset inventory.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
assetPartId |
path |
integer(int64) |
true |
Unique identifier for the asset part |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Find Vendor¶
HTTP Request
POST /api/vendors/search
📋 Description: Submits a search query to retrieve vendor information based on specified criteria, enabling efficient vendor management and selection processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the search results should be returned in a paginated format, allowing for efficient navigation through large sets of vendor data. |
|
body |
body |
true |
Request body containing search criteria parameters to identify and retrieve vendor information based on specified attributes. |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idNotIn": [
6 0
7 ],
8 "displayIdLike": "string",
9 "nameLike": "string",
10 "addressLike": "string",
11 "vendorAvailable": true,
12 "attachToAssetIdIn": [
13 0
14 ],
15 "attachToAssetIdNotIn": [
16 0
17 ],
18 "attachToAssetPartIdIn": [
19 0
20 ],
21 "attachToAssetPartIdNotIn": [
22 0
23 ],
24 "attachToPremiseIdIn": [
25 0
26 ],
27 "attachToPremiseIdNotIn": [
28 0
29 ],
30 "vendorStatusIn": [
31 0
32 ],
33 "vendorTypeIn": "string",
34 "businessTypeIn": [
35 0
36 ]
37}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "createdBy": "string",
24 "createdAt": "2019-08-24T14:15:22Z",
25 "displayId": "string",
26 "name": "string",
27 "description": "string",
28 "address": "string",
29 "contractEndDate": "2019-08-24",
30 "services": "string",
31 "vendorType": "string",
32 "vendorStatusId": 0,
33 "vendorStatus": "string",
34 "vendorStatusType": "string",
35 "businessTypeId": 0,
36 "businessType": "string",
37 "vendorRateId": 0,
38 "vendorRate": "string",
39 "vendorContactIds": [
40 0
41 ],
42 "premiseIds": [
43 0
44 ],
45 "firstPremiseDisplayId": "string",
46 "ownerUserName": "string",
47 "ownerDto": {
48 "id": 0,
49 "createdBy": "string",
50 "createdAt": "2019-08-24T14:15:22Z",
51 "userName": "string",
52 "firstName": "string",
53 "lastName": "string",
54 "email": "string",
55 "roleIds": [
56 {
57 "id": 0,
58 "createdBy": "string",
59 "createdAt": "2019-08-24T14:15:22Z",
60 "modifiedBy": "string",
61 "modifiedAt": "2019-08-24T14:15:22Z",
62 "roleName": "string",
63 "entity": "string",
64 "new": true
65 }
66 ],
67 "internalTeamNames": [
68 "string"
69 ],
70 "internalTeamIds": [
71 0
72 ],
73 "internalTeamDisplayIds": [
74 "string"
75 ],
76 "premiseIds": [
77 0
78 ],
79 "premiseNames": [
80 "string"
81 ],
82 "userAvailable": true,
83 "temporaryWorkload": 0,
84 "preferredCultureCode": "string"
85 },
86 "vendorAvailable": true,
87 "vendorRating": 0.1,
88 "premiseDisplayIds": [
89 "string"
90 ]
91 }
92 ],
93 "number": 0,
94 "sort": {
95 "unsorted": true,
96 "sorted": true,
97 "empty": true
98 },
99 "empty": true
100}
Copy Vendor¶
HTTP Request
POST /api/vendors/copyVendor/{id}
📋 Description: Copies an existing vendor record identified by the specified ID, allowing for efficient duplication of vendor information within the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
name |
query |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "displayId": "string",
6 "name": "string",
7 "description": "string",
8 "address": "string",
9 "contractEndDate": "2019-08-24",
10 "services": "string",
11 "vendorType": "string",
12 "vendorStatusId": 0,
13 "vendorStatus": "string",
14 "vendorStatusType": "string",
15 "businessTypeId": 0,
16 "businessType": "string",
17 "vendorRateId": 0,
18 "vendorRate": "string",
19 "vendorContactIds": [
20 0
21 ],
22 "premiseIds": [
23 0
24 ],
25 "firstPremiseDisplayId": "string",
26 "ownerUserName": "string",
27 "ownerDto": {
28 "id": 0,
29 "createdBy": "string",
30 "createdAt": "2019-08-24T14:15:22Z",
31 "userName": "string",
32 "firstName": "string",
33 "lastName": "string",
34 "email": "string",
35 "roleIds": [
36 {
37 "id": 0,
38 "createdBy": "string",
39 "createdAt": "2019-08-24T14:15:22Z",
40 "modifiedBy": "string",
41 "modifiedAt": "2019-08-24T14:15:22Z",
42 "roleName": "string",
43 "entity": "string",
44 "new": true
45 }
46 ],
47 "internalTeamNames": [
48 "string"
49 ],
50 "internalTeamIds": [
51 0
52 ],
53 "internalTeamDisplayIds": [
54 "string"
55 ],
56 "premiseIds": [
57 0
58 ],
59 "premiseNames": [
60 "string"
61 ],
62 "userAvailable": true,
63 "temporaryWorkload": 0,
64 "preferredCultureCode": "string"
65 },
66 "vendorAvailable": true,
67 "vendorRating": 0.1,
68 "premiseDisplayIds": [
69 "string"
70 ]
71}
Get All Documents By Vendor¶
HTTP Request
GET /api/vendors/{id}/documents
📋 Description: Retrieves all documents associated with a specific vendor, identified by the provided vendor ID, to facilitate effective document management and review processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "contentType": "string",
8 "documentTypeName": "string",
9 "documentTypeId": 0,
10 "description": "string",
11 "data": "string",
12 "startDate": "2019-08-24",
13 "endDate": "2019-08-24",
14 "documentStatusId": 0,
15 "documentStatus": "string",
16 "documentStatusType": "string",
17 "parentEntityId": 0,
18 "link": "string",
19 "parentEntityName": "string"
20 }
21]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a document within the enterprise system, encapsulating essential attributes such as title, content, and metadata for effective document management and retrieval.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» contentType |
string |
false |
none |
Type of the content |
» documentTypeName |
string |
false |
none |
Name of the document type |
» documentTypeId |
integer(int64) |
false |
none |
Unique identifier for the document type |
» description |
string |
false |
none |
Description of the resource |
» data |
string(byte) |
false |
none |
Contains the primary content of the document, providing essential information relevant to the associated business process. |
» startDate |
string(date) |
false |
none |
Start date of the resource |
» endDate |
string(date) |
false |
none |
End date of the resource |
» documentStatusId |
integer(int64) |
false |
none |
Unique identifier for the document status |
» documentStatus |
string |
false |
none |
Status of the document |
» documentStatusType |
string |
false |
none |
Type of the document status |
» parentEntityId |
integer(int64) |
true |
none |
Unique identifier for the parent entity |
» link |
string |
false |
none |
URL reference to the associated document, facilitating easy access and retrieval within the system. |
» parentEntityName |
string |
true |
none |
Name of the parent entity |
Get Documents By Vendor ID¶
HTTP Request
GET /api/vendors/{id}/documents/{documentId}
📋 Description: Fetches the specified document associated with a vendor, providing essential details for review and management of vendor-related documentation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
documentId |
path |
integer(int64) |
true |
Unique identifier for the document |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "name": "string",
6 "contentType": "string",
7 "documentTypeName": "string",
8 "documentTypeId": 0,
9 "description": "string",
10 "data": "string",
11 "startDate": "2019-08-24",
12 "endDate": "2019-08-24",
13 "documentStatusId": 0,
14 "documentStatus": "string",
15 "documentStatusType": "string",
16 "parentEntityId": 0,
17 "link": "string",
18 "parentEntityName": "string"
19}
Find All Asset Parts By Vendor ID¶
HTTP Request
GET /api/vendors/{id}/assetParts
📋 Description: Fetches the asset parts associated with a specific vendor, enabling users to manage and review inventory components effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "displayId": "string",
7 "name": "string",
8 "description": "string",
9 "imageId": 0,
10 "premiseId": 0,
11 "premiseDisplayId": "string",
12 "premiseDto": {
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "displayId": "string",
17 "premiseName": "string",
18 "description": "string",
19 "address": "string",
20 "internalTeamNames": [
21 "string"
22 ],
23 "internalTeamIds": [
24 0
25 ],
26 "premiseAvailable": true,
27 "premiseFromNrm": true,
28 "nlmId": 0,
29 "nlmDisplayId": "string",
30 "nlmUsed": true,
31 "manager": 0,
32 "managerName": "string",
33 "imageId": 0,
34 "area": "string",
35 "modifiedAt": "2019-08-24T14:15:22Z"
36 },
37 "premiseFromNrm": true,
38 "model": "string",
39 "unitCost": "67.08",
40 "serialNumber": "string",
41 "qrCode": "string",
42 "quantityOnHand": 0,
43 "reOrderPoint": 0,
44 "size": "string",
45 "color": "string",
46 "weight": "24.08",
47 "length": "11.5",
48 "width": "16.9",
49 "height": "12.3",
50 "materialType": "string",
51 "assetPartType": "string",
52 "assetPartTypeId": 0,
53 "assetPartManufacturer": {
54 "id": 0,
55 "createdBy": "string",
56 "createdAt": "2019-08-24T14:15:22Z",
57 "name": "string",
58 "assetParts": [
59 {}
60 ]
61 },
62 "variableQuantity": 0,
63 "assetPartAvailable": true,
64 "owner": 0,
65 "ownerDto": {
66 "id": 0,
67 "createdBy": "string",
68 "createdAt": "2019-08-24T14:15:22Z",
69 "userName": "string",
70 "firstName": "string",
71 "lastName": "string",
72 "email": "string",
73 "roleIds": [
74 {
75 "id": 0,
76 "createdBy": "string",
77 "createdAt": "2019-08-24T14:15:22Z",
78 "modifiedBy": "string",
79 "modifiedAt": "2019-08-24T14:15:22Z",
80 "roleName": "string",
81 "entity": "string",
82 "new": true
83 }
84 ],
85 "internalTeamNames": [
86 "string"
87 ],
88 "internalTeamIds": [
89 0
90 ],
91 "internalTeamDisplayIds": [
92 "string"
93 ],
94 "premiseIds": [
95 0
96 ],
97 "premiseNames": [
98 "string"
99 ],
100 "userAvailable": true,
101 "temporaryWorkload": 0,
102 "preferredCultureCode": "string"
103 },
104 "ownerUserName": "string",
105 "modifiedAt": "2019-08-24T14:15:22Z",
106 "isPartsSufficient": true
107 }
108]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a component of an asset, detailing its specifications and associated metadata for effective asset management and tracking within the enterprise.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» displayId |
string |
false |
none |
Unique identifier for the display |
» name |
string |
true |
none |
Name of the resource |
» description |
string |
false |
none |
Description of the resource |
» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
» premiseId |
integer(int64) |
false |
none |
Unique identifier for the premise |
» premiseDisplayId |
string |
false |
none |
Unique identifier for the premise display |
» premiseDto |
false |
none |
Data transfer object representing a premise, encapsulating essential details such as location, type, and associated attributes to facilitate effective decision-making in real estate and operational planning. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» displayId |
string |
false |
none |
Unique identifier for the display |
»» premiseName |
string |
false |
none |
Name of the premise |
»» description |
string |
false |
none |
Description of the resource |
»» address |
string |
true |
none |
Represents the physical location associated with the premise, essential for logistics and service delivery. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
List of unique identifiers representing the internal teams associated with the premise, facilitating streamlined collaboration and resource allocation. |
»» premiseAvailable |
boolean |
false |
none |
Indicates whether the premise is available for use within the specified context. |
»» premiseFromNrm |
boolean |
false |
none |
Indicates whether the premise is sourced from the National Resource Management (NRM) framework, facilitating compliance and reporting within environmental management processes. |
»» nlmId |
integer(int64) |
false |
none |
Unique identifier for the nlm |
»» nlmDisplayId |
string |
false |
none |
Unique identifier for the nlm display |
»» nlmUsed |
boolean |
false |
none |
Indicates whether the National Labor Market (NLM) resources have been utilized in the premise evaluation process. |
»» manager |
integer(int64) |
false |
none |
Unique identifier for the manager associated with the premise, facilitating effective organizational hierarchy and resource management. |
»» managerName |
string |
false |
none |
Name of the manager |
»» imageId |
integer(int64) |
false |
none |
Unique identifier for the image |
»» area |
string |
false |
none |
Represents the geographic area associated with the premise, providing essential context for location-based services and analysis. |
»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» premiseFromNrm |
boolean |
false |
none |
Indicates whether the asset part originates from the National Resource Management (NRM) framework, facilitating compliance and reporting requirements. |
» model |
string |
false |
none |
Represents the specific model associated with the asset part, facilitating accurate identification and management within the system. |
» unitCost |
string |
false |
none |
Represents the cost per unit of the asset part, essential for accurate budgeting and financial analysis within asset management. |
» serialNumber |
string |
false |
none |
Unique identifier for the asset part, facilitating efficient tracking and management within the asset management system. |
» qrCode |
string |
false |
none |
Code for the qr |
» quantityOnHand |
integer(int64) |
false |
none |
Represents the current inventory level of the asset part, indicating the quantity available for use or sale. |
» reOrderPoint |
integer(int64) |
false |
none |
Reorder point indicates the inventory level at which new stock should be ordered to prevent stockouts and ensure continuous availability of asset parts. |
» size |
string |
false |
none |
Number of items per page |
» color |
string |
false |
none |
Represents the color attribute associated with the asset part, providing essential visual differentiation for inventory management and asset tracking. |
» weight |
string |
false |
none |
Represents the weight of the asset part, providing essential information for inventory management and logistics optimization. |
» length |
string |
false |
none |
Specifies the length of the asset part, providing essential information for inventory management and resource allocation. |
» width |
string |
false |
none |
Specifies the width dimension of the asset part, facilitating accurate representation and management of asset specifications. |
» height |
string |
false |
none |
Specifies the height of the asset part, providing essential dimensional information for inventory and asset management. |
» materialType |
string |
false |
none |
Type of the material |
» assetPartType |
string |
false |
none |
Type of the asset part |
» assetPartTypeId |
integer(int64) |
false |
none |
Unique identifier for the asset part type |
» assetPartManufacturer |
false |
none |
Data transfer object representing the manufacturer details of an asset part, including essential identification and classification information to facilitate inventory management and procurement processes. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» name |
string |
false |
none |
Name of the resource |
»» assetParts |
false |
none |
An array of asset parts, represented by AssetPartManufacturerDTO, that details the components associated with each asset for effective inventory and resource management. |
|
» variableQuantity |
integer(int64) |
false |
none |
Quantity of variable quantity |
» assetPartAvailable |
boolean |
false |
none |
Indicates whether the specific asset part is currently available for allocation or use within the system. |
» owner |
integer(int64) |
false |
none |
Unique identifier for the owner of the asset part, facilitating asset management and accountability within the system. |
» ownerDto |
false |
none |
Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» userName |
string |
false |
none |
Name of the user |
»» firstName |
string |
false |
none |
Name of the first |
»» lastName |
string |
false |
none |
Name of the last |
string |
false |
none |
Email address of the user, used for communication and account verification purposes within the system. |
|
»» roleIds |
false |
none |
Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system. |
|
»»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»»» createdBy |
string |
false |
none |
Username of who created this resource |
»»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»»» modifiedBy |
string |
false |
none |
Username of who last modified this resource |
»»» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
»»» roleName |
string |
false |
none |
Name of the role |
»»» entity |
string |
false |
none |
Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management. |
»»» new |
boolean |
false |
none |
Indicates whether the role is newly created within the system, facilitating effective management of organizational changes. |
»» internalTeamNames |
[string] |
false |
none |
List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization. |
»» internalTeamIds |
[integer] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization. |
»» internalTeamDisplayIds |
[string] |
false |
none |
An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration. |
»» premiseIds |
[integer] |
false |
none |
Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations. |
»» premiseNames |
[string] |
false |
none |
List of names associated with the user’s premises, providing essential context for location-based services and operations. |
»» userAvailable |
boolean |
false |
none |
Indicates whether the user is available for assignment or engagement within the system. |
»» temporaryWorkload |
integer(int32) |
false |
none |
Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning. |
»» preferredCultureCode |
string |
false |
none |
Code for the preferred culture |
» ownerUserName |
string |
false |
none |
Name of the owner user |
» modifiedAt |
string(date-time) |
false |
none |
Timestamp when this resource was last modified |
» isPartsSufficient |
boolean |
false |
none |
Whether the resource is parts sufficient |
Get All Active Vendor Status Type IDs¶
HTTP Request
GET /api/vendors/allActiveVendorStatusTypes
📋 Description: Retrieves a list of all active vendor status types, providing essential information for vendor management and operational decision-making.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 0
3]
Response Schema
Delete Vendor Contact¶
HTTP Request
DELETE /api/vendors/vendorContacts/{contactId}
📋 Description: Deletes a specified vendor contact from the system, ensuring that outdated or irrelevant contact information is removed to maintain accurate vendor records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
contactId |
path |
integer(int64) |
true |
Unique identifier for the contact |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |