WEBIndividualInsert

Initial Build

2008.01

xWEB

Web Method

Response Type

object

The WEBIndividualInsert web method inserts a new individual record.

Parameters

The request contains the following parameters:

Name Type Occurs Description
oFacadeObject IndividualType 0($)..1 The IndividualType to be inserted.

Response

IndividualType—The newly inserted individual, with additional data set and a new primary key contained in the CurrentKey property.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>2306bae2-4f6f-499c-8b8b-daffb79abb9b</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<ns:oFacadeObject>
[[IndividualType]]
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

The response matches the input fields and includes the customer key and record number if one was not passed into netFORUM.

Use Cases

Insert Individual with Organization Name - Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>b9eb6347-342b-4b86-bbc8-76837cded1e5</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_first_name>Francis</ns:ind_first_name>
<ns:ind_last_name>Scott</ns:ind_last_name>
</ns:Individual>
<ns:Customer>
<ns:cst_org_name_dn>FARM Test Org</ns:cst_org_name_dn>
</ns:Customer>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>

Insert Individual with Organization Name - Result

WEBIndividualInsert Individual With Org Name.jpg

Insert Individual with Related Organization - Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>0e0e12f7-50ac-459d-acba-c333c8fa1cd9</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_first_name>Francis</ns:ind_first_name>
<ns:ind_last_name>Scott</ns:ind_last_name>
</ns:Individual>
<ns:Organization_XRef>
<ns:ixo_rlt_code>Staff</ns:ixo_rlt_code>
<ns:ixo_title>Assistant</ns:ixo_title>
<ns:ixo_org_cst_key>93f99466-93ab-48e7-be72-7d2eb9f69e47</ns:ixo_org_cst_key>
</ns:Organization_XRef>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>

Insert Individual with Related Organization - Result

WEBIndividualInsert With Related Org

Insert Individual with Contact Information Using System Defaults - Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>f4496783-4379-4dcc-b399-0a5c80180b5d</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<!--Optional:-->
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_prf_code>Test Prefix</ns:ind_prf_code>
<ns:ind_sfx_code>Test Suffix</ns:ind_sfx_code>
<ns:ind_first_name>Julie</ns:ind_first_name>
<ns:ind_last_name>Test</ns:ind_last_name>
<ns:ind_designation/>
</ns:Individual>
<ns:Customer>
<ns:cst_ixo_title_dn>Staff</ns:cst_ixo_title_dn>
<ns:cst_org_name_dn>Laser Registration</ns:cst_org_name_dn>
<ns:cst_phn_number_complete_dn>2022222222</ns:cst_phn_number_complete_dn>
</ns:Customer>
<ns:Email>
<ns:eml_address>test@avectra.com</ns:eml_address>
</ns:Email>
<ns:Business_Address>
<ns:adr_line1>123 ABC</ns:adr_line1>
<ns:adr_line2/>
<ns:adr_city>Washington</ns:adr_city>
<ns:adr_state>DC</ns:adr_state>
<ns:adr_post_code>20001</ns:adr_post_code>
</ns:Business_Address>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>

Insert Individual with Contact Information Specifying Address and Email Type - Request XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>f4496783-4379-4dcc-b399-0a5c80180b5d</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBIndividualInsert>
<!--Optional:-->
<ns:oFacadeObject>
<ns:Individual>
<ns:ind_prf_code>Test Prefix</ns:ind_prf_code>
<ns:ind_sfx_code>Test Suffix</ns:ind_sfx_code>
<ns:ind_first_name>Julie</ns:ind_first_name>
<ns:ind_last_name>Test</ns:ind_last_name>
<ns:ind_designation/>
</ns:Individual>
<ns:Customer>
<ns:cst_ixo_title_dn>Staff</ns:cst_ixo_title_dn>
<ns:cst_org_name_dn>Laser Registration</ns:cst_org_name_dn>
<ns:cst_phn_number_complete_dn>2022222222</ns:cst_phn_number_complete_dn>
</ns:Customer>
<ns:Email>
<ns:eml_address>test@avectra.com</ns:eml_address>
<ns:eml_type>personal</ns:eml_type>
<ns:eml_primary>1</ns:eml_primary>
</ns:Email>
<ns:Business_Address>
<ns:adr_line1>123 ABC</ns:adr_line1>
<ns:adr_line2/>
<ns:adr_city>Washington</ns:adr_city>
<ns:adr_state>DC</ns:adr_state>
<ns:adr_post_code>20001</ns:adr_post_code>
</ns:Business_Address>
<ns:Business_Address_XRef>
<ns:cxa_adt_key>4B63F9A8-D9A1-4F1D-A5B3-FCCF2DC83ADF</ns:cxa_adt_key>
<ns:cxa_primary>1</ns:cxa_primary>
</ns:Business_Address_XRef>
</ns:oFacadeObject>
</ns:WEBIndividualInsert>
</soapenv:Body>
</soapenv:Envelope>

Individual Insert with Linked Address

At this time, it is not possible to insert a linked address with a new individual in xWeb.