Accounts Web Service

Accounts

Click here for a complete list of operations.

CreateContact

Creates a contact within AIMS, and returns the new contact's contact id

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 /Accounts.asmx HTTP/1.1
Host: parkmobile.townofbwg.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.edc-aim.com/schemas/accounts_ws/CreateContact"

<?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>
    <CreateContact xmlns="http://www.edc-aim.com/schemas/accounts_ws/">
      <contact>
        <contactid>int</contactid>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <PrimaryAddress>
          <addressid>int</addressid>
          <addresstypeid>int</addresstypeid>
          <Street1>string</Street1>
          <Street2>string</Street2>
          <Street3>string</Street3>
          <City>string</City>
          <stateid>int</stateid>
          <State>
            <stateid>int</stateid>
            <Code>string</Code>
            <Description>string</Description>
          </State>
          <StateCode>string</StateCode>
          <ZipCode>string</ZipCode>
          <IsPrimary>boolean</IsPrimary>
        </PrimaryAddress>
        <PrimaryPhone>
          <phoneid>int</phoneid>
          <AreaCode>string</AreaCode>
          <Number>string</Number>
          <Extension>string</Extension>
          <PhoneNumber>string</PhoneNumber>
          <phonetypeid>int</phonetypeid>
          <IsPrimary>boolean</IsPrimary>
        </PrimaryPhone>
        <PrimaryEmail>
          <emailid>int</emailid>
          <emailtypeid>int</emailtypeid>
          <Email>string</Email>
          <IsPrimary>boolean</IsPrimary>
        </PrimaryEmail>
        <Addresses>
          <ApiAddressInfo>
            <addressid>int</addressid>
            <addresstypeid>int</addresstypeid>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <Street3>string</Street3>
            <City>string</City>
            <stateid>int</stateid>
            <State xsi:nil="true" />
            <StateCode>string</StateCode>
            <ZipCode>string</ZipCode>
            <IsPrimary>boolean</IsPrimary>
          </ApiAddressInfo>
          <ApiAddressInfo>
            <addressid>int</addressid>
            <addresstypeid>int</addresstypeid>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <Street3>string</Street3>
            <City>string</City>
            <stateid>int</stateid>
            <State xsi:nil="true" />
            <StateCode>string</StateCode>
            <ZipCode>string</ZipCode>
            <IsPrimary>boolean</IsPrimary>
          </ApiAddressInfo>
        </Addresses>
        <Phones>
          <ApiPhoneInfo>
            <phoneid>int</phoneid>
            <AreaCode>string</AreaCode>
            <Number>string</Number>
            <Extension>string</Extension>
            <PhoneNumber>string</PhoneNumber>
            <phonetypeid>int</phonetypeid>
            <IsPrimary>boolean</IsPrimary>
          </ApiPhoneInfo>
          <ApiPhoneInfo>
            <phoneid>int</phoneid>
            <AreaCode>string</AreaCode>
            <Number>string</Number>
            <Extension>string</Extension>
            <PhoneNumber>string</PhoneNumber>
            <phonetypeid>int</phonetypeid>
            <IsPrimary>boolean</IsPrimary>
          </ApiPhoneInfo>
        </Phones>
        <Emails>
          <ApiEmailInfo>
            <emailid>int</emailid>
            <emailtypeid>int</emailtypeid>
            <Email>string</Email>
            <IsPrimary>boolean</IsPrimary>
          </ApiEmailInfo>
          <ApiEmailInfo>
            <emailid>int</emailid>
            <emailtypeid>int</emailtypeid>
            <Email>string</Email>
            <IsPrimary>boolean</IsPrimary>
          </ApiEmailInfo>
        </Emails>
        <IDs>
          <ApiContactIDInfo>
            <contactid>int</contactid>
            <idtypeid>int</idtypeid>
            <Value>string</Value>
          </ApiContactIDInfo>
          <ApiContactIDInfo>
            <contactid>int</contactid>
            <idtypeid>int</idtypeid>
            <Value>string</Value>
          </ApiContactIDInfo>
        </IDs>
        <DiscFields>
          <ApiContactDiscInfo>
            <contactid>int</contactid>
            <contactdisctypeid>int</contactdisctypeid>
            <Value>string</Value>
          </ApiContactDiscInfo>
          <ApiContactDiscInfo>
            <contactid>int</contactid>
            <contactdisctypeid>int</contactdisctypeid>
            <Value>string</Value>
          </ApiContactDiscInfo>
        </DiscFields>
      </contact>
    </CreateContact>
  </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>
    <CreateContactResponse xmlns="http://www.edc-aim.com/schemas/accounts_ws/">
      <CreateContactResult>int</CreateContactResult>
    </CreateContactResponse>
  </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 /Accounts.asmx HTTP/1.1
Host: parkmobile.townofbwg.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>
    <CreateContact xmlns="http://www.edc-aim.com/schemas/accounts_ws/">
      <contact>
        <contactid>int</contactid>
        <FirstName>string</FirstName>
        <MiddleName>string</MiddleName>
        <LastName>string</LastName>
        <PrimaryAddress>
          <addressid>int</addressid>
          <addresstypeid>int</addresstypeid>
          <Street1>string</Street1>
          <Street2>string</Street2>
          <Street3>string</Street3>
          <City>string</City>
          <stateid>int</stateid>
          <State>
            <stateid>int</stateid>
            <Code>string</Code>
            <Description>string</Description>
          </State>
          <StateCode>string</StateCode>
          <ZipCode>string</ZipCode>
          <IsPrimary>boolean</IsPrimary>
        </PrimaryAddress>
        <PrimaryPhone>
          <phoneid>int</phoneid>
          <AreaCode>string</AreaCode>
          <Number>string</Number>
          <Extension>string</Extension>
          <PhoneNumber>string</PhoneNumber>
          <phonetypeid>int</phonetypeid>
          <IsPrimary>boolean</IsPrimary>
        </PrimaryPhone>
        <PrimaryEmail>
          <emailid>int</emailid>
          <emailtypeid>int</emailtypeid>
          <Email>string</Email>
          <IsPrimary>boolean</IsPrimary>
        </PrimaryEmail>
        <Addresses>
          <ApiAddressInfo>
            <addressid>int</addressid>
            <addresstypeid>int</addresstypeid>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <Street3>string</Street3>
            <City>string</City>
            <stateid>int</stateid>
            <State xsi:nil="true" />
            <StateCode>string</StateCode>
            <ZipCode>string</ZipCode>
            <IsPrimary>boolean</IsPrimary>
          </ApiAddressInfo>
          <ApiAddressInfo>
            <addressid>int</addressid>
            <addresstypeid>int</addresstypeid>
            <Street1>string</Street1>
            <Street2>string</Street2>
            <Street3>string</Street3>
            <City>string</City>
            <stateid>int</stateid>
            <State xsi:nil="true" />
            <StateCode>string</StateCode>
            <ZipCode>string</ZipCode>
            <IsPrimary>boolean</IsPrimary>
          </ApiAddressInfo>
        </Addresses>
        <Phones>
          <ApiPhoneInfo>
            <phoneid>int</phoneid>
            <AreaCode>string</AreaCode>
            <Number>string</Number>
            <Extension>string</Extension>
            <PhoneNumber>string</PhoneNumber>
            <phonetypeid>int</phonetypeid>
            <IsPrimary>boolean</IsPrimary>
          </ApiPhoneInfo>
          <ApiPhoneInfo>
            <phoneid>int</phoneid>
            <AreaCode>string</AreaCode>
            <Number>string</Number>
            <Extension>string</Extension>
            <PhoneNumber>string</PhoneNumber>
            <phonetypeid>int</phonetypeid>
            <IsPrimary>boolean</IsPrimary>
          </ApiPhoneInfo>
        </Phones>
        <Emails>
          <ApiEmailInfo>
            <emailid>int</emailid>
            <emailtypeid>int</emailtypeid>
            <Email>string</Email>
            <IsPrimary>boolean</IsPrimary>
          </ApiEmailInfo>
          <ApiEmailInfo>
            <emailid>int</emailid>
            <emailtypeid>int</emailtypeid>
            <Email>string</Email>
            <IsPrimary>boolean</IsPrimary>
          </ApiEmailInfo>
        </Emails>
        <IDs>
          <ApiContactIDInfo>
            <contactid>int</contactid>
            <idtypeid>int</idtypeid>
            <Value>string</Value>
          </ApiContactIDInfo>
          <ApiContactIDInfo>
            <contactid>int</contactid>
            <idtypeid>int</idtypeid>
            <Value>string</Value>
          </ApiContactIDInfo>
        </IDs>
        <DiscFields>
          <ApiContactDiscInfo>
            <contactid>int</contactid>
            <contactdisctypeid>int</contactdisctypeid>
            <Value>string</Value>
          </ApiContactDiscInfo>
          <ApiContactDiscInfo>
            <contactid>int</contactid>
            <contactdisctypeid>int</contactdisctypeid>
            <Value>string</Value>
          </ApiContactDiscInfo>
        </DiscFields>
      </contact>
    </CreateContact>
  </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>
    <CreateContactResponse xmlns="http://www.edc-aim.com/schemas/accounts_ws/">
      <CreateContactResult>int</CreateContactResult>
    </CreateContactResponse>
  </soap12:Body>
</soap12:Envelope>