POST api/v1/SynchronizePartial

Request Information

URI Parameters

None.

Body Parameters

SynchronizePartialParameter
NameDescriptionTypeAdditional information
Users

Collection of User

None.

Teams

Collection of Team

None.

JournalTypes

Collection of JournalType

None.

JournalItems

Collection of JournalItem

None.

DeleteJournalItemIDs

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "Users": [
    {
      "ID": "sample string 1",
      "SP_ID": 2,
      "DisplayName": "sample string 3",
      "LoginName": "sample string 4",
      "SP_IsSiteAdmin": true,
      "EmailAddresses": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "ID": "sample string 1",
      "SP_ID": 2,
      "DisplayName": "sample string 3",
      "LoginName": "sample string 4",
      "SP_IsSiteAdmin": true,
      "EmailAddresses": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "Teams": [
    {
      "ID": "sample string 1",
      "SP_ID": "sample string 2",
      "Name": "sample string 3",
      "SystemGenerated": true,
      "IsDomainGroup": true,
      "SecurityIdentifier": "sample string 6",
      "SamAccountName": "sample string 7",
      "TeamMemberLoginNames": [
        "sample string 1",
        "sample string 2"
      ],
      "TeamMemberWithDomainGroups": [
        {
          "LoginName": "sample string 1",
          "DomainGroupSecurityIdentifier": "sample string 2",
          "DomainGroupSamAccountName": "sample string 3",
          "DomainGroupName": "sample string 4"
        },
        {
          "LoginName": "sample string 1",
          "DomainGroupSecurityIdentifier": "sample string 2",
          "DomainGroupSamAccountName": "sample string 3",
          "DomainGroupName": "sample string 4"
        }
      ]
    },
    {
      "ID": "sample string 1",
      "SP_ID": "sample string 2",
      "Name": "sample string 3",
      "SystemGenerated": true,
      "IsDomainGroup": true,
      "SecurityIdentifier": "sample string 6",
      "SamAccountName": "sample string 7",
      "TeamMemberLoginNames": [
        "sample string 1",
        "sample string 2"
      ],
      "TeamMemberWithDomainGroups": [
        {
          "LoginName": "sample string 1",
          "DomainGroupSecurityIdentifier": "sample string 2",
          "DomainGroupSamAccountName": "sample string 3",
          "DomainGroupName": "sample string 4"
        },
        {
          "LoginName": "sample string 1",
          "DomainGroupSecurityIdentifier": "sample string 2",
          "DomainGroupSamAccountName": "sample string 3",
          "DomainGroupName": "sample string 4"
        }
      ]
    }
  ],
  "JournalTypes": [
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "AccessControlTeamSP_IDs": [
        "sample string 1",
        "sample string 2"
      ],
      "IntID": 3
    },
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "AccessControlTeamSP_IDs": [
        "sample string 1",
        "sample string 2"
      ],
      "IntID": 3
    }
  ],
  "JournalItems": [
    {
      "ID": "sample string 1",
      "SP_ID": 2,
      "Name": "sample string 3",
      "ParentID": "sample string 4",
      "JournalTypeID": "sample string 5",
      "JournalTypeName": "sample string 6",
      "EmailAddresses": [
        "sample string 1",
        "sample string 2"
      ],
      "AccessControlInfos": [
        {
          "TeamSP_ID": "sample string 1",
          "AddPermission": true,
          "DeletePermission": true,
          "IsWorkPointSecurity": true
        },
        {
          "TeamSP_ID": "sample string 1",
          "AddPermission": true,
          "DeletePermission": true,
          "IsWorkPointSecurity": true
        }
      ],
      "FieldValues": [
        {
          "JournalItemID": "sample string 1",
          "JournalTypeFieldID": 2,
          "Value": "sample string 3"
        },
        {
          "JournalItemID": "sample string 1",
          "JournalTypeFieldID": 2,
          "Value": "sample string 3"
        }
      ],
      "PerformPendingCheck": true,
      "Editor": "sample string 7",
      "ModifiedDate": "2024-03-29T13:46:20.8732356+00:00",
      "SharePointEmailAddresses": "sample string 9"
    },
    {
      "ID": "sample string 1",
      "SP_ID": 2,
      "Name": "sample string 3",
      "ParentID": "sample string 4",
      "JournalTypeID": "sample string 5",
      "JournalTypeName": "sample string 6",
      "EmailAddresses": [
        "sample string 1",
        "sample string 2"
      ],
      "AccessControlInfos": [
        {
          "TeamSP_ID": "sample string 1",
          "AddPermission": true,
          "DeletePermission": true,
          "IsWorkPointSecurity": true
        },
        {
          "TeamSP_ID": "sample string 1",
          "AddPermission": true,
          "DeletePermission": true,
          "IsWorkPointSecurity": true
        }
      ],
      "FieldValues": [
        {
          "JournalItemID": "sample string 1",
          "JournalTypeFieldID": 2,
          "Value": "sample string 3"
        },
        {
          "JournalItemID": "sample string 1",
          "JournalTypeFieldID": 2,
          "Value": "sample string 3"
        }
      ],
      "PerformPendingCheck": true,
      "Editor": "sample string 7",
      "ModifiedDate": "2024-03-29T13:46:20.8732356+00:00",
      "SharePointEmailAddresses": "sample string 9"
    }
  ],
  "DeleteJournalItemIDs": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SynchronizePartialParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
  <DeleteJournalItemIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DeleteJournalItemIDs>
  <JournalItems>
    <JournalItem>
      <AccessControlInfos>
        <JournalItem.AccessControlInfo>
          <AddPermission>true</AddPermission>
          <DeletePermission>true</DeletePermission>
          <IsWorkPointSecurity>true</IsWorkPointSecurity>
          <TeamSP_ID>sample string 1</TeamSP_ID>
        </JournalItem.AccessControlInfo>
        <JournalItem.AccessControlInfo>
          <AddPermission>true</AddPermission>
          <DeletePermission>true</DeletePermission>
          <IsWorkPointSecurity>true</IsWorkPointSecurity>
          <TeamSP_ID>sample string 1</TeamSP_ID>
        </JournalItem.AccessControlInfo>
      </AccessControlInfos>
      <Editor>sample string 7</Editor>
      <EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EmailAddresses>
      <FieldValues>
        <JournalItemFieldValue>
          <JournalItemID>sample string 1</JournalItemID>
          <JournalTypeFieldID>2</JournalTypeFieldID>
          <Value>sample string 3</Value>
        </JournalItemFieldValue>
        <JournalItemFieldValue>
          <JournalItemID>sample string 1</JournalItemID>
          <JournalTypeFieldID>2</JournalTypeFieldID>
          <Value>sample string 3</Value>
        </JournalItemFieldValue>
      </FieldValues>
      <ID>sample string 1</ID>
      <JournalTypeID>sample string 5</JournalTypeID>
      <JournalTypeName>sample string 6</JournalTypeName>
      <ModifiedDate>2024-03-29T13:46:20.8732356+00:00</ModifiedDate>
      <Name>sample string 3</Name>
      <ParentID>sample string 4</ParentID>
      <PerformPendingCheck>true</PerformPendingCheck>
      <SP_ID>2</SP_ID>
      <SharePointEmailAddresses>sample string 9</SharePointEmailAddresses>
    </JournalItem>
    <JournalItem>
      <AccessControlInfos>
        <JournalItem.AccessControlInfo>
          <AddPermission>true</AddPermission>
          <DeletePermission>true</DeletePermission>
          <IsWorkPointSecurity>true</IsWorkPointSecurity>
          <TeamSP_ID>sample string 1</TeamSP_ID>
        </JournalItem.AccessControlInfo>
        <JournalItem.AccessControlInfo>
          <AddPermission>true</AddPermission>
          <DeletePermission>true</DeletePermission>
          <IsWorkPointSecurity>true</IsWorkPointSecurity>
          <TeamSP_ID>sample string 1</TeamSP_ID>
        </JournalItem.AccessControlInfo>
      </AccessControlInfos>
      <Editor>sample string 7</Editor>
      <EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EmailAddresses>
      <FieldValues>
        <JournalItemFieldValue>
          <JournalItemID>sample string 1</JournalItemID>
          <JournalTypeFieldID>2</JournalTypeFieldID>
          <Value>sample string 3</Value>
        </JournalItemFieldValue>
        <JournalItemFieldValue>
          <JournalItemID>sample string 1</JournalItemID>
          <JournalTypeFieldID>2</JournalTypeFieldID>
          <Value>sample string 3</Value>
        </JournalItemFieldValue>
      </FieldValues>
      <ID>sample string 1</ID>
      <JournalTypeID>sample string 5</JournalTypeID>
      <JournalTypeName>sample string 6</JournalTypeName>
      <ModifiedDate>2024-03-29T13:46:20.8732356+00:00</ModifiedDate>
      <Name>sample string 3</Name>
      <ParentID>sample string 4</ParentID>
      <PerformPendingCheck>true</PerformPendingCheck>
      <SP_ID>2</SP_ID>
      <SharePointEmailAddresses>sample string 9</SharePointEmailAddresses>
    </JournalItem>
  </JournalItems>
  <JournalTypes>
    <JournalType>
      <AccessControlTeamSP_IDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AccessControlTeamSP_IDs>
      <ID>sample string 1</ID>
      <IntID>3</IntID>
      <Name>sample string 2</Name>
    </JournalType>
    <JournalType>
      <AccessControlTeamSP_IDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </AccessControlTeamSP_IDs>
      <ID>sample string 1</ID>
      <IntID>3</IntID>
      <Name>sample string 2</Name>
    </JournalType>
  </JournalTypes>
  <Teams>
    <Team>
      <ID>sample string 1</ID>
      <IsDomainGroup>true</IsDomainGroup>
      <Name>sample string 3</Name>
      <SP_ID>sample string 2</SP_ID>
      <SamAccountName>sample string 7</SamAccountName>
      <SecurityIdentifier>sample string 6</SecurityIdentifier>
      <SystemGenerated>true</SystemGenerated>
      <TeamMemberLoginNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TeamMemberLoginNames>
      <TeamMemberWithDomainGroups>
        <TeamMemberWithDomainGroup>
          <DomainGroupName>sample string 4</DomainGroupName>
          <DomainGroupSamAccountName>sample string 3</DomainGroupSamAccountName>
          <DomainGroupSecurityIdentifier>sample string 2</DomainGroupSecurityIdentifier>
          <LoginName>sample string 1</LoginName>
        </TeamMemberWithDomainGroup>
        <TeamMemberWithDomainGroup>
          <DomainGroupName>sample string 4</DomainGroupName>
          <DomainGroupSamAccountName>sample string 3</DomainGroupSamAccountName>
          <DomainGroupSecurityIdentifier>sample string 2</DomainGroupSecurityIdentifier>
          <LoginName>sample string 1</LoginName>
        </TeamMemberWithDomainGroup>
      </TeamMemberWithDomainGroups>
    </Team>
    <Team>
      <ID>sample string 1</ID>
      <IsDomainGroup>true</IsDomainGroup>
      <Name>sample string 3</Name>
      <SP_ID>sample string 2</SP_ID>
      <SamAccountName>sample string 7</SamAccountName>
      <SecurityIdentifier>sample string 6</SecurityIdentifier>
      <SystemGenerated>true</SystemGenerated>
      <TeamMemberLoginNames xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </TeamMemberLoginNames>
      <TeamMemberWithDomainGroups>
        <TeamMemberWithDomainGroup>
          <DomainGroupName>sample string 4</DomainGroupName>
          <DomainGroupSamAccountName>sample string 3</DomainGroupSamAccountName>
          <DomainGroupSecurityIdentifier>sample string 2</DomainGroupSecurityIdentifier>
          <LoginName>sample string 1</LoginName>
        </TeamMemberWithDomainGroup>
        <TeamMemberWithDomainGroup>
          <DomainGroupName>sample string 4</DomainGroupName>
          <DomainGroupSamAccountName>sample string 3</DomainGroupSamAccountName>
          <DomainGroupSecurityIdentifier>sample string 2</DomainGroupSecurityIdentifier>
          <LoginName>sample string 1</LoginName>
        </TeamMemberWithDomainGroup>
      </TeamMemberWithDomainGroups>
    </Team>
  </Teams>
  <Users>
    <User>
      <DisplayName>sample string 3</DisplayName>
      <EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EmailAddresses>
      <ID>sample string 1</ID>
      <LoginName>sample string 4</LoginName>
      <SP_ID>2</SP_ID>
      <SP_IsSiteAdmin>true</SP_IsSiteAdmin>
    </User>
    <User>
      <DisplayName>sample string 3</DisplayName>
      <EmailAddresses xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </EmailAddresses>
      <ID>sample string 1</ID>
      <LoginName>sample string 4</LoginName>
      <SP_ID>2</SP_ID>
      <SP_IsSiteAdmin>true</SP_IsSiteAdmin>
    </User>
  </Users>
</SynchronizePartialParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SynchronizeResult
NameDescriptionTypeAdditional information
SynchronizeType

SynchronizeType

None.

ID

string

None.

SynchronizeOperation

SynchronizeOperation

None.

ErrorNumber

integer

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SynchronizeType": 0,
    "ID": "sample string 1",
    "SynchronizeOperation": 10,
    "ErrorNumber": 2,
    "ErrorMessage": "sample string 3"
  },
  {
    "SynchronizeType": 0,
    "ID": "sample string 1",
    "SynchronizeOperation": 10,
    "ErrorNumber": 2,
    "ErrorMessage": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSynchronizeResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
  <SynchronizeResult>
    <ErrorMessage>sample string 3</ErrorMessage>
    <ErrorNumber>2</ErrorNumber>
    <ID>sample string 1</ID>
    <SynchronizeOperation>Insert</SynchronizeOperation>
    <SynchronizeType>User</SynchronizeType>
  </SynchronizeResult>
  <SynchronizeResult>
    <ErrorMessage>sample string 3</ErrorMessage>
    <ErrorNumber>2</ErrorNumber>
    <ID>sample string 1</ID>
    <SynchronizeOperation>Insert</SynchronizeOperation>
    <SynchronizeType>User</SynchronizeType>
  </SynchronizeResult>
</ArrayOfSynchronizeResult>