TAG LINE
TAG LINE
SMALL TITLE
This object represents the hierarchy connections between different accounts within the system.
identity READ-ONLY | "identity": 19 Type: Number This is the unique numeric identifier for the AccountParent |
accountId | "accountId": 25 Type: Number Unique identifier for the associated Account object. |
accountName | "accountName": "Sample Name" Type: String The name of the object associated with the accountId property. |
parentAccountId | "parentAccountId": 2 Type: Number Unique identifier for the associated Account object. |
parentAccountName | "parentAccountName": "Sample Name" Type: String The name of the object associated with the parentAccountId property. |
topAccountId READ-ONLY | "topAccountId": 13 Type: Number Unique identifier for the associated Account object. |
topAccountName READ-ONLY | "topAccountName": "Sample Name" Type: String The name of the object associated with the topAccountId property. |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format. |
DELETE | Account/Parent/{id} |
Delete an instance of the AccountParent object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
{id} | Unique identifier for the AccountParent object. |
Delete an instance of the AccountParent object. DELETE Account/Parent/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "accountParent" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } } |
GET | Account/Parent/ |
Retrieve all of the AccountParent objects. | |
Retrieve all of the AccountParent objects. GET Account/Parent/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "accountId": 9, "accountName": "Sample Text Data", "parentAccountId": 20, "parentAccountName": "Sample Text Data", "topAccountId": 2, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" } ] } |
GET | Account/Parent/Paged |
Retrieve all of the AccountParent objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints. | |
Retrieve all of the AccountParent objects in a paged fashion. GET Account/Parent/Paged HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "accountId": 2, "accountName": "Sample Text Data", "parentAccountId": 12, "parentAccountName": "Sample Text Data", "topAccountId": 18, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" } ] } } |
GET | Account/Parent/{id} |
Retrieve an instance of the AccountParent object by its ID. | |
{id} | Unique identifier for the AccountParent object. |
Retrieve an instance of the AccountParent object by its ID. GET Account/Parent/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "accountId": 21, "accountName": "Sample Text Data", "parentAccountId": 26, "parentAccountName": "Sample Text Data", "topAccountId": 26, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" } } |
POST | Account/Parent/ |
Create a new instance of the AccountParent object. | |
Create a new instance of the AccountParent object. POST Account/Parent/ { "accountId": 9, "parentAccountId": 8, "updated": "2021-04-26T15:25:27.587Z" } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "create", "results": { "totalCount": 1, "items": [ { "identity": 1, "accountId": 12, "accountName": "Sample Text Data", "parentAccountId": 11, "parentAccountName": "Sample Text Data", "topAccountId": 25, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" } ] } } |
PUT | Account/Parent/{id} |
Update an existing instance of the AccountParent object. | |
Update an existing instance of the AccountParent object. PUT Account/Parent/{id} { "identity": 1, "accountId": 6, "parentAccountId": 12, "updated": "2021-04-26T15:25:27.587Z" } HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "update", "results": { "totalCount": 1, "items": [ { "identity": 1, "accountId": 21, "accountName": "Sample Text Data", "parentAccountId": 14, "parentAccountName": "Sample Text Data", "topAccountId": 12, "topAccountName": "Sample Text Data", "updated": "2021-04-26T15:25:27.587Z" } ] } } |