<back to all web services
Company
Create or maintain Company records.
The following routes are available for this service:POST | /company | Create Company Record. | |
---|
PUT | /company/{CompanyId} | Update Company Record. | |
---|
DELETE | /company/{CompanyId} | Delete Company Record. | |
---|
GET | /company/{CompanyId} | Retrieve a Company Record. | |
---|
TypeCompany Parameters:Name | Parameter | Data Type | Required | Description |
---|
CompanyId | form | Guid | No | |
ParentCompanyId | form | string | No | |
CompanyName | form | string | No | |
Website | form | string | No | |
CompanyNameShort | form | string | No | |
IsReseller | form | bool | No | |
SeparateInvoice | form | bool | No | |
TypeCompanyStatusId | form | int | No | |
ModifiedBy | form | Guid | No | |
ModifiedDate | form | DateTime | No | |
ChannelCompanies | form | List<TypeCompany> | No | |
TypeCompany Parameters:Name | Parameter | Data Type | Required | Description |
---|
CompanyId | form | Guid | No | |
CompanyName | form | string | No | |
Website | form | string | No | |
CompanyNameShort | form | string | No | |
IsReseller | form | bool | No | |
TypeCompanyStatusId | form | int | No | |
ModifiedBy | form | Guid | No | |
ModifiedDate | form | DateTime | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /company HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Company xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.DTO">
<_x003C_ChannelCompanies_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">
<TypeCompany>
<_x003C_ChannelCompanies_x003E_k__BackingField>
<TypeCompany>
<_x003C_ChannelCompanies_x003E_k__BackingField>
<TypeCompany>
<_x003C_ChannelCompanies_x003E_k__BackingField i:nil="true" />
<_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
<_x003C_CompanyNameShort_x003E_k__BackingField>String</_x003C_CompanyNameShort_x003E_k__BackingField>
<_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
<_x003C_IsReseller_x003E_k__BackingField>false</_x003C_IsReseller_x003E_k__BackingField>
<_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
<_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
<_x003C_ParentCompanyId_x003E_k__BackingField>String</_x003C_ParentCompanyId_x003E_k__BackingField>
<_x003C_SeparateInvoice_x003E_k__BackingField>false</_x003C_SeparateInvoice_x003E_k__BackingField>
<_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
<_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
</TypeCompany>
</_x003C_ChannelCompanies_x003E_k__BackingField>
<_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
<_x003C_CompanyNameShort_x003E_k__BackingField>String</_x003C_CompanyNameShort_x003E_k__BackingField>
<_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
<_x003C_IsReseller_x003E_k__BackingField>false</_x003C_IsReseller_x003E_k__BackingField>
<_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
<_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
<_x003C_ParentCompanyId_x003E_k__BackingField>String</_x003C_ParentCompanyId_x003E_k__BackingField>
<_x003C_SeparateInvoice_x003E_k__BackingField>false</_x003C_SeparateInvoice_x003E_k__BackingField>
<_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
<_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
</TypeCompany>
</_x003C_ChannelCompanies_x003E_k__BackingField>
<_x003C_CompanyId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
<_x003C_CompanyNameShort_x003E_k__BackingField>String</_x003C_CompanyNameShort_x003E_k__BackingField>
<_x003C_CompanyName_x003E_k__BackingField>String</_x003C_CompanyName_x003E_k__BackingField>
<_x003C_IsReseller_x003E_k__BackingField>false</_x003C_IsReseller_x003E_k__BackingField>
<_x003C_ModifiedBy_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
<_x003C_ModifiedDate_x003E_k__BackingField>0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
<_x003C_ParentCompanyId_x003E_k__BackingField>String</_x003C_ParentCompanyId_x003E_k__BackingField>
<_x003C_SeparateInvoice_x003E_k__BackingField>false</_x003C_SeparateInvoice_x003E_k__BackingField>
<_x003C_TypeCompanyStatusId_x003E_k__BackingField>0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
<_x003C_Website_x003E_k__BackingField>String</_x003C_Website_x003E_k__BackingField>
</TypeCompany>
</_x003C_ChannelCompanies_x003E_k__BackingField>
<_x003C_CompanyId_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</_x003C_CompanyId_x003E_k__BackingField>
<_x003C_CompanyNameShort_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</_x003C_CompanyNameShort_x003E_k__BackingField>
<_x003C_CompanyName_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</_x003C_CompanyName_x003E_k__BackingField>
<_x003C_IsReseller_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</_x003C_IsReseller_x003E_k__BackingField>
<_x003C_ModifiedBy_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">00000000-0000-0000-0000-000000000000</_x003C_ModifiedBy_x003E_k__BackingField>
<_x003C_ModifiedDate_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0001-01-01T00:00:00</_x003C_ModifiedDate_x003E_k__BackingField>
<_x003C_ParentCompanyId_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</_x003C_ParentCompanyId_x003E_k__BackingField>
<_x003C_SeparateInvoice_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">false</_x003C_SeparateInvoice_x003E_k__BackingField>
<_x003C_TypeCompanyStatusId_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">0</_x003C_TypeCompanyStatusId_x003E_k__BackingField>
<_x003C_Website_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/N3TEntities.Logins">String</_x003C_Website_x003E_k__BackingField>
</Company>