Veetro Web Service Methods
Click here for a complete list of operations.
GetCompany
[Permission: Any Authenticated]
Returns the Company containing the provided EntityID. If fullDetails is False, Arrays/Collection attributes such as Branches will not be populated (fullDetails=False is suitable for listings where in-depth data is not required.) Non-employee users cannot access contact details other than their own.
Please Note: The auto-generated SOAP examples do not include inherited properties such as EntityID, Email, etc. Use a proper WSDL framework to generate XML or see GetEntity for XML node reference.
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetCompany"
<?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>
<GetCompany xmlns="http://schema.veetro.com">
<EntityID>int</EntityID>
<fullDetails>boolean</fullDetails>
</GetCompany>
</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>
<GetCompanyResponse xmlns="http://schema.veetro.com">
<GetCompanyResult>
<Branches>
<Branch>
<Members xsi:nil="true" />
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses xsi:nil="true" />
<CustomFields xsi:nil="true" />
</Branch>
<Branch>
<Members xsi:nil="true" />
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses xsi:nil="true" />
<CustomFields xsi:nil="true" />
</Branch>
</Branches>
<CompanyBlog>string</CompanyBlog>
</GetCompanyResult>
</GetCompanyResponse>
</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 /xml HTTP/1.1
Host: admin.worketc.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>
<GetCompany xmlns="http://schema.veetro.com">
<EntityID>int</EntityID>
<fullDetails>boolean</fullDetails>
</GetCompany>
</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>
<GetCompanyResponse xmlns="http://schema.veetro.com">
<GetCompanyResult>
<Branches>
<Branch>
<Members xsi:nil="true" />
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses xsi:nil="true" />
<CustomFields xsi:nil="true" />
</Branch>
<Branch>
<Members xsi:nil="true" />
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses xsi:nil="true" />
<CustomFields xsi:nil="true" />
</Branch>
</Branches>
<CompanyBlog>string</CompanyBlog>
</GetCompanyResult>
</GetCompanyResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /xml/GetCompany?EntityID=string&fullDetails=string HTTP/1.1 Host: admin.worketc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Company xmlns="http://schema.veetro.com">
<Branches>
<Branch>
<Members>
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Members>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses>
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Addresses>
<CustomFields>
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</CustomFields>
</Branch>
<Branch>
<Members>
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Members>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses>
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Addresses>
<CustomFields>
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</CustomFields>
</Branch>
</Branches>
<CompanyBlog>string</CompanyBlog>
</Company>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/GetCompany HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length EntityID=string&fullDetails=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<Company xmlns="http://schema.veetro.com">
<Branches>
<Branch>
<Members>
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Members>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses>
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Addresses>
<CustomFields>
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</CustomFields>
</Branch>
<Branch>
<Members>
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<BranchMember d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Members>
<BranchID>int</BranchID>
<Delete>boolean</Delete>
<BranchName>string</BranchName>
<IsPrimary>boolean</IsPrimary>
<Addresses>
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Address d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</Addresses>
<CustomFields>
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
<Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
</CustomFields>
</Branch>
</Branches>
<CompanyBlog>string</CompanyBlog>
</Company>