POST api/progressionchain/{id}/addchainlink

Add node to progression chain

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

The chain link information

AddChainLinkDataContract
NameDescriptionTypeAdditional information
Source

integer

None.

Target

integer

None.

Circular

boolean

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Source": 1,
  "Target": 2,
  "Circular": true,
  "Id": 4
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProgressionChainDataContract
NameDescriptionTypeAdditional information
Nodes

Collection of ChainItemDataContract

None.

Links

Collection of ChainLinkDataContract

None.

Property

PropertyDataContract

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Nodes": [
    {
      "Notes": "sample string 1",
      "Reference": "sample string 2",
      "Up": [
        1,
        2
      ],
      "Down": [
        1,
        2
      ],
      "Id": 3
    },
    {
      "Notes": "sample string 1",
      "Reference": "sample string 2",
      "Up": [
        1,
        2
      ],
      "Down": [
        1,
        2
      ],
      "Id": 3
    }
  ],
  "Links": [
    {
      "Source": 1,
      "Target": 2,
      "Circular": true,
      "Id": 4
    },
    {
      "Source": 1,
      "Target": 2,
      "Circular": true,
      "Id": 4
    }
  ],
  "Property": {
    "Address": {
      "Location": {
        "CenterPoint": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Extent": [
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          }
        ],
        "ViewPoints": [
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          },
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          }
        ],
        "Id": 1
      },
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 1",
      "OrganizationName": "sample string 2",
      "Number": "sample string 3",
      "BuildingName": "sample string 4",
      "Street": "sample string 5",
      "Town": "sample string 6",
      "Locality": "sample string 7",
      "County": "sample string 8",
      "Postcode": "sample string 9",
      "CreatedDate": "2020-11-25T02:45:42.385999Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 11
    },
    "Keys": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2",
        "IsCheckedOut": true,
        "IsPermanent": true,
        "CheckedInAt": "2020-11-25T02:45:42.385999Z",
        "CheckedInBy": {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 4",
          "Id": 5
        },
        "NoteOnCheckIn": "sample string 5",
        "CheckedOutAt": "2020-11-25T02:45:42.385999Z",
        "CheckedOutBy": {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 4",
          "Id": 5
        },
        "NoteOnCheckOut": "sample string 6",
        "RecipientDetails": {
          "RecipientId": 1,
          "RecipientName": "sample string 2",
          "RecipientGroupName": "sample string 3",
          "RecipientType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          }
        },
        "Id": 7
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2",
        "IsCheckedOut": true,
        "IsPermanent": true,
        "CheckedInAt": "2020-11-25T02:45:42.385999Z",
        "CheckedInBy": {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 4",
          "Id": 5
        },
        "NoteOnCheckIn": "sample string 5",
        "CheckedOutAt": "2020-11-25T02:45:42.385999Z",
        "CheckedOutBy": {
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 1",
          "FirstName": "sample string 2",
          "LastName": "sample string 3",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 4",
          "Id": 5
        },
        "NoteOnCheckOut": "sample string 6",
        "RecipientDetails": {
          "RecipientId": 1,
          "RecipientName": "sample string 2",
          "RecipientGroupName": "sample string 3",
          "RecipientType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          }
        },
        "Id": 7
      }
    ],
    "Alarms": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2",
        "Id": 3
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2",
        "Id": 3
      }
    ],
    "Roles": [
      {
        "OwningTeamId": 1,
        "BranchId": 2,
        "Name": "sample string 3",
        "TeamAccessType": "sample string 4",
        "RoleType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "RoleStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CustomFields": [
          {
            "Name": "sample string 1",
            "Values": [
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              },
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              }
            ]
          },
          {
            "Name": "sample string 1",
            "Values": [
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              },
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              }
            ]
          }
        ],
        "CreatedDate": "2020-11-25T02:45:42.385999Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 6
      },
      {
        "OwningTeamId": 1,
        "BranchId": 2,
        "Name": "sample string 3",
        "TeamAccessType": "sample string 4",
        "RoleType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "RoleStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "CustomFields": [
          {
            "Name": "sample string 1",
            "Values": [
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              },
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              }
            ]
          },
          {
            "Name": "sample string 1",
            "Values": [
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              },
              {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 1",
                "Value": {}
              }
            ]
          }
        ],
        "CreatedDate": "2020-11-25T02:45:42.385999Z",
        "CreatedBy": {
          "Initials": "sample string 1",
          "ContactName": "sample string 2",
          "Gender": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Title": "sample string 3",
          "FirstName": "sample string 4",
          "LastName": "sample string 5",
          "PrimaryTelephone": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "PrimaryEmail": {
            "Type": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Value": "sample string 1",
            "Notes": "sample string 2",
            "ContactOrder": 3,
            "AllowContact": true,
            "MarketingContactStatus": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Name": "sample string 5",
            "Id": 6
          },
          "JobTitle": "sample string 6",
          "Id": 7
        },
        "Id": 6
      }
    ],
    "InactiveRoleIds": [
      1,
      2
    ],
    "SpecialArrangements": [
      {
        "Text": "sample string 1",
        "SpecialArrangementType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ApplicableToGroupIds": [
          1,
          2
        ],
        "Id": 2
      },
      {
        "Text": "sample string 1",
        "SpecialArrangementType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "ApplicableToGroupIds": [
          1,
          2
        ],
        "Id": 2
      }
    ],
    "SystemStatusName": "sample string 1",
    "Certificates": [
      {
        "Name": "sample string 1",
        "CertificateType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Document": {
          "Url": "sample string 1",
          "RequiresAuthentication": true,
          "ExpiryDate": "2020-11-25T02:45:42.385999Z",
          "FileStream": null,
          "Tags": [
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            },
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            }
          ],
          "DocumentType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "DocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FileName": "sample string 3",
          "ContentType": "sample string 4",
          "FileExtension": "sample string 5",
          "Description": "sample string 6",
          "FileSize": "sample string 7",
          "CreatedDate": "2020-11-25T02:45:42.385999Z",
          "CreatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 9
        },
        "StartDate": "2020-11-25T02:45:42.385999Z",
        "ExpiryDate": "2020-11-25T02:45:42.385999Z",
        "ReceivedDate": "2020-11-25T02:45:42.385999Z",
        "Expired": true,
        "Id": 6
      },
      {
        "Name": "sample string 1",
        "CertificateType": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Document": {
          "Url": "sample string 1",
          "RequiresAuthentication": true,
          "ExpiryDate": "2020-11-25T02:45:42.385999Z",
          "FileStream": null,
          "Tags": [
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            },
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            }
          ],
          "DocumentType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "DocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FileName": "sample string 3",
          "ContentType": "sample string 4",
          "FileExtension": "sample string 5",
          "Description": "sample string 6",
          "FileSize": "sample string 7",
          "CreatedDate": "2020-11-25T02:45:42.385999Z",
          "CreatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 9
        },
        "StartDate": "2020-11-25T02:45:42.385999Z",
        "ExpiryDate": "2020-11-25T02:45:42.385999Z",
        "ReceivedDate": "2020-11-25T02:45:42.385999Z",
        "Expired": true,
        "Id": 6
      }
    ],
    "Id": 2
  },
  "Id": 1
}