PersonSvc Web Service

PersonSvc

Click here for a complete list of operations.

InsertRelatedEntity

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /SingleView/Entities/PersonSvc.asmx HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SoapAction: "http://services.simplicitycrm.com/dataintegration/InsertRelatedEntity"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InsertRelatedEntity xmlns="http://services.simplicitycrm.com/dataintegration">
      <Token>string</Token>
      <RSN>string</RSN>
      <DisplayValue>string</DisplayValue>
      <EntityToInsert>
        <Relationship_Type>OrderPartyPicker_Order_Person or Organisation_CurrentEmployerStaff_Person or Organisation_EmployerStaff_Person or SecurityAccount_OwnedBy_Person or Staff_FriendsAndFamily_Left_Perspective or Staff_FriendsAndFamily_Right_Perspective or Organisation_PreviousEmployerStaff_Person or Card_Person or Invoice_BillToPerson or Invoice_Person or ProgramMembership_Person or AuditLog_Entity_x_EntityColumn_Person or AuditLog_Entity_x_LookupListItem_Person or ManagementGroup_x_Person or Manager_x_Session or AuditLog_Entity_x_OptInOptOut_Person or Case_x_Person or Project_x_BillToContact or OnlineShoppingAccount_Person or Project_x_EmailInvoiceContact or PurchaseOrder_Customer_Person or Person_CampaignExecutionNotification or CustomerAccount_Owner_Person or Person_ChannelBlock_Dealer or Person_Employer or Person_LegacySystemHistory or Person_OrderBilled or Person_OrderCancelled or Person_OrderCompleted or Person_OrderCreditHold or Person_OrderInProgress or Person_OrderOpportunity or Person_OrderQuotation or Person_OrderToBeBilled or Person_Registrant or PurchaseOrder_Supplier_Person or RecipientOrganisation_x_CampaignExecution or RecipientPerson_x_CampaignExecution or Person_RemoteSystemCustomerCode or Person_SurveyAnswers or Person_x_AccountManager or Person_x_Action or Person_x_AuditNotes or Person_x_BinaryData or Person_x_Dealer or Person_x_Documents or Person_x_Notes or Person_x_OriginatingSource or Person_x_Program or Person_x_SecurityAccount or Survey_SurveyAnswers_Person or TransactionItem_Person or Person_WeChatPost or Voucher_x_Person or Order_BillToContact_Person or Order_BillToPerson or Order_Person or Person_WeChatUser or FacebookApplication_Users or FacebookCompanyPage_Fans or FacebookCompetitorPage_Fans or FacebookInterestedInPage_Fans or FacebookPage_Fans or RelStaffEmployer_ApprovingManager or DataLoad_Rel_Staff_Employer_x_Person or Order_x_AgencyContact or Order_x_BriefedBy or Order_x_EmailInvoiceContact or CampaignArchive_ActivitySummary_Person or CustomerAccount_Person or DataLoad_Person_x_Person or CampaignList_Entity_Person or CampaignList_Person</Relationship_Type>
        <Join_RSN>string</Join_RSN>
        <Entity_RSN>string</Entity_RSN>
        <Entity_DisplayValue>string</Entity_DisplayValue>
        <Entity_Type>string</Entity_Type>
      </EntityToInsert>
    </InsertRelatedEntity>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <InsertRelatedEntityResponse xmlns="http://services.simplicitycrm.com/dataintegration">
      <InsertRelatedEntityResult>int</InsertRelatedEntityResult>
    </InsertRelatedEntityResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /SingleView/Entities/PersonSvc.asmx HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <InsertRelatedEntity xmlns="http://services.simplicitycrm.com/dataintegration">
      <Token>string</Token>
      <RSN>string</RSN>
      <DisplayValue>string</DisplayValue>
      <EntityToInsert>
        <Relationship_Type>OrderPartyPicker_Order_Person or Organisation_CurrentEmployerStaff_Person or Organisation_EmployerStaff_Person or SecurityAccount_OwnedBy_Person or Staff_FriendsAndFamily_Left_Perspective or Staff_FriendsAndFamily_Right_Perspective or Organisation_PreviousEmployerStaff_Person or Card_Person or Invoice_BillToPerson or Invoice_Person or ProgramMembership_Person or AuditLog_Entity_x_EntityColumn_Person or AuditLog_Entity_x_LookupListItem_Person or ManagementGroup_x_Person or Manager_x_Session or AuditLog_Entity_x_OptInOptOut_Person or Case_x_Person or Project_x_BillToContact or OnlineShoppingAccount_Person or Project_x_EmailInvoiceContact or PurchaseOrder_Customer_Person or Person_CampaignExecutionNotification or CustomerAccount_Owner_Person or Person_ChannelBlock_Dealer or Person_Employer or Person_LegacySystemHistory or Person_OrderBilled or Person_OrderCancelled or Person_OrderCompleted or Person_OrderCreditHold or Person_OrderInProgress or Person_OrderOpportunity or Person_OrderQuotation or Person_OrderToBeBilled or Person_Registrant or PurchaseOrder_Supplier_Person or RecipientOrganisation_x_CampaignExecution or RecipientPerson_x_CampaignExecution or Person_RemoteSystemCustomerCode or Person_SurveyAnswers or Person_x_AccountManager or Person_x_Action or Person_x_AuditNotes or Person_x_BinaryData or Person_x_Dealer or Person_x_Documents or Person_x_Notes or Person_x_OriginatingSource or Person_x_Program or Person_x_SecurityAccount or Survey_SurveyAnswers_Person or TransactionItem_Person or Person_WeChatPost or Voucher_x_Person or Order_BillToContact_Person or Order_BillToPerson or Order_Person or Person_WeChatUser or FacebookApplication_Users or FacebookCompanyPage_Fans or FacebookCompetitorPage_Fans or FacebookInterestedInPage_Fans or FacebookPage_Fans or RelStaffEmployer_ApprovingManager or DataLoad_Rel_Staff_Employer_x_Person or Order_x_AgencyContact or Order_x_BriefedBy or Order_x_EmailInvoiceContact or CampaignArchive_ActivitySummary_Person or CustomerAccount_Person or DataLoad_Person_x_Person or CampaignList_Entity_Person or CampaignList_Person</Relationship_Type>
        <Join_RSN>string</Join_RSN>
        <Entity_RSN>string</Entity_RSN>
        <Entity_DisplayValue>string</Entity_DisplayValue>
        <Entity_Type>string</Entity_Type>
      </EntityToInsert>
    </InsertRelatedEntity>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <InsertRelatedEntityResponse xmlns="http://services.simplicitycrm.com/dataintegration">
      <InsertRelatedEntityResult>int</InsertRelatedEntityResult>
    </InsertRelatedEntityResponse>
  </soap12:Body>
</soap12:Envelope>

JSON

The following is a sample JSON request and response. The placeholders shown need to be replaced with actual values.

PUT /SingleView/api/Entities/PersonSvc/{RSN:string}/rel/{Relationship_Type:string} HTTP/1.1
Host: www.simplicitycrm.com
Content-Type: application/json; charset=utf-8
Content-Length: length
Authorization: Token string

{
  "DisplayValue":string,
  "EntityToInsert":{
    "Join_RSN":string,
    "Entity_RSN":string,
    "Entity_DisplayValue":string,
    "Entity_Type":string,
  },
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length

{
  "ErrorCode":int,
}