API Reference

Manage groups

Create or update groups

Call template

All DataTable calls can be POST or GET.

https://{OrangeLogicURL}/API/DataTable/v2.1/API/datatable/v2.1/Contact.Group:CreateorUpdate?Contact.CoreField.Title_English={Group Name}&{group metadata}

Identify a group by name, and then specify new values for any of the group’s metadata fields.

Create or Update

If the group already exists, a CreateorUpdate call updates the group. If the group does not exist, this call creates a new group.

Example 1: Create a new group

This call looks for a group with the name “Archivist interns.” If no group with that name is found, the call creates a new group with the name and code “Archivists interns.”

/API/datatable/v2.1/Contact.Group:CreateorUpdate?Contact.CoreField.Title_English=Archivist interns&Contact.CoreField.Code:=Archivist interns&Contact.CoreField.Title_English:=Archivist interns

Example call 
curl --location --request POST 'https://mangovations.com/API/datatable/v2.1/Contact.Group:CreateorUpdate?Contact.CoreField.Title_English=Archivist%20interns&Contact.CoreField.Code%3A=Archivist%20interns&Contact.CoreField.Title_English%3A=Archivist%20interns' \
--header 'Authorization: Bearer ui0NKJjIjqrKZsU9bMwEgtdfScDDmH5OddzXCpWqlV0DqAZZ1NAePGmU@BTo0aBeixC0OqcIPvm41cfTi8rUSNodJr.pCYafenEsSjj5.nSgDvdXJc9hYjsJFoVmSRFp' \
--header 'Cookie: AWSALB=WiDzArDR/SRCXaujO9KWQpHaR7mrvKqPKWZFQ2Xl8dZLD1uEe7DFhdDA6JdTNFqWKLwnvWYUflLWq9uutnOiD67PsaFRgcDjg3PPuNAFyagawLI6FYqUpcqytRfO; AWSALBCORS=WiDzArDR/SRCXaujO9KWQpHaR7mrvKqPKWZFQ2Xl8dZLD1uEe7DFhdDA6JdTNFqWKLwnvWYUflLWq9uutnOiD67PsaFRgcDjg3PPuNAFyagawLI6FYqUpcqytRfO; AWSALBTG=g/8KNt/xHkgzb6HkceTekV9nSaOZn9p9/2BcElHmWSKenqpArdHVbKB8F7DxtyTyQT2WylMLTfP5NFQEu85HqeaJkYgyqUarvNuGvBkC+BOIGQK0ZTvL41aVYIoRaYd3OfNCo3FytFQNyi539NvsAPFtgPigd+l9TRS35Z0PR7W7; AWSALBTGCORS=g/8KNt/xHkgzb6HkceTekV9nSaOZn9p9/2BcElHmWSKenqpArdHVbKB8F7DxtyTyQT2WylMLTfP5NFQEu85HqeaJkYgyqUarvNuGvBkC+BOIGQK0ZTvL41aVYIoRaYd3OfNCo3FytFQNyi539NvsAPFtgPigd+l9TRS35Z0PR7W7; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B28Sn%2F0T7j86y2sGViFevb%2FkaViZW0QIer84lOGO3rIBF3xZeDVvTm%2FVGusnzv46vqVtfxtH%2BjfV5JCg%2BWvK%2FCSvBLLyZeXqO4rVcpWCPka58Iyrdop7YnOwlAMEMW9iiwe1ot1UckmeDYgg%2Ftx9yyX; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B28Sn%2F0T7j86y2sGViFevb%2FkaViZW0QIer84lOGO3rIBF3xZeDVvTm%2FVGusnzv46vqVtfxtH%2BjfV5JCg%2BWvK%2FCSvBLLyZeXqO4rVcpWCPka58Iyrdop7YnOwlAMEMW9iiwe1ot1UckmeDYgg%2Ftx9yyX'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>datatable</Module>
    <APIVersion>v2.1</APIVersion>
    <Resource>Contact.Group:CreateorUpdate</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Updates type="List">
      <Update>
        <Field>Contact.CoreField.Code</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Archivist interns</Value>
      </Update>
      <Update>
        <Field>Contact.CoreField.Title_English</Field>
        <Operator>:=</Operator>
        <OperatorDescription>Assign a value to a single-value field</OperatorDescription>
        <Value>Archivist interns</Value>
      </Update>
    </Updates>
    <Filters type="List">
      <Filter>
        <Field>Contact.CoreField.Title_English</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>Archivist interns</Value>
      </Filter>
    </Filters>
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <Response>
    <RecordID>K8OECVIJO3</RecordID>
    <Code>SUCCESS</Code>
  </Response>
</Result>

Delete

Example 2: Delete a group

This call deletes the group with the name “Archivist interns.”

/API/datatable/v2.1/Contact.Group:Delete?Contact.CoreField.Title_English=Archivist interns

Example call 
curl --location --request POST 'https://mangovations.com/API/datatable/v2.1/Contact.Group:Delete?Contact.CoreField.Title_English=Archivist%20interns' \
--header 'Authorization: Bearer UtauyEDOUwmjdqfPh59s00AtWEPqiDiKFKKGclom5NVE6eI.q@[email protected]@wUMInnZAGcAXJOo23ZADFJ' \
--header 'Cookie: AWSALB=eG4nSMbXTXuETcpydZsKQ9LIBtxzG3axFwoCIR7OzSNG7SV6SR7d0kfY+bnxBYIQDmG9CHPzqcj59JE1pvcO6wziOxfkRI0L0MPAP6mNoIw7TZzOIBczUtipKOkv; AWSALBCORS=eG4nSMbXTXuETcpydZsKQ9LIBtxzG3axFwoCIR7OzSNG7SV6SR7d0kfY+bnxBYIQDmG9CHPzqcj59JE1pvcO6wziOxfkRI0L0MPAP6mNoIw7TZzOIBczUtipKOkv; AWSALBTG=nYkH2GVV9qKbc/iRrxkwCvR/5h2oeJ9szUFbxgVLFWT/bFideK0IWfbgKob1d71tMfoxpgrMpxXfhLoi2N9YQvTCQXB/13uXzhZZ6cFsWliQog9EIerNH1I/Nys/XPutV6WftW54zVVzxXLN3M2B97ItvhWYQos2fiBnOV14YZa5; AWSALBTGCORS=nYkH2GVV9qKbc/iRrxkwCvR/5h2oeJ9szUFbxgVLFWT/bFideK0IWfbgKob1d71tMfoxpgrMpxXfhLoi2N9YQvTCQXB/13uXzhZZ6cFsWliQog9EIerNH1I/Nys/XPutV6WftW54zVVzxXLN3M2B97ItvhWYQos2fiBnOV14YZa5; CortexCID_ZZ1=NK2uiOOw0h7gcj0c; ZZ1-Session__1505=CfDJ8KSkO661hSREsDx7PGb48%2B2ix4SHn%2BXQzXO5D89NNttvigNlox0GGYvrncDKe9p%2Bryy%2FbkdO9yz%2FhruuwwvN2gcS1iFri%2F8PPGt2OVTLteQn%2BoCnvusK27QpBY0tdGHhMUMT31lX9qQONd483z8rTs1KLPKooTfV%2B1jyPriZhZXe; ZZ1-Session__1505-Alt=CfDJ8KSkO661hSREsDx7PGb48%2B2ix4SHn%2BXQzXO5D89NNttvigNlox0GGYvrncDKe9p%2Bryy%2FbkdO9yz%2FhruuwwvN2gcS1iFri%2F8PPGt2OVTLteQn%2BoCnvusK27QpBY0tdGHhMUMT31lX9qQONd483z8rTs1KLPKooTfV%2B1jyPriZhZXe'
Response 
<Result>
  <APIRequestInfo>
    <ProviderVersion>KOBE.R2.2065G.216363</ProviderVersion>
    <ProviderIdentity>OLU-T-USW2-APP</ProviderIdentity>
    <ProviderID>44ddde3ac27a33c394335f249d4007d4</ProviderID>
    <Module>datatable</Module>
    <APIVersion>v2.1</APIVersion>
    <Resource>Contact.Group:Delete</Resource>
    <IsLoggedIn type="Boolean">True</IsLoggedIn>
    <Status>LoggedIn</Status>
    <UserLogin>ZZ1CT12218</UserLogin>
    <Session>No session (production configuration)</Session>
    <TimeoutPeriodMinutes type="Numeric">120</TimeoutPeriodMinutes>
  </APIRequestInfo>
  <RequestInterpretation>
    <Filters type="List">
      <Filter>
        <Field>Contact.CoreField.Title_English</Field>
        <Operator>=</Operator>
        <OperatorDescription>Field must be equal to value</OperatorDescription>
        <Value>Archivist interns</Value>
      </Filter>
    </Filters>
    <Updates type="List" />
    <IgnoredParameters type="List" />
  </RequestInterpretation>
  <ResponseSummary>
    <NumberOfRecordsAffected type="Numeric">1</NumberOfRecordsAffected>
  </ResponseSummary>
  <Response>
    <RecordsAffected type="List">
      <Result>
        <RecordID>K8OECVIT4E</RecordID>
        <Code>SUCCESS</Code>
      </Result>
    </RecordsAffected>
  </Response>
</Result>