Exigo Web Services API v2022.12.19.1

 Search

GetCompanyNewsItem

Gets company news details.

Input Properties

GetCompanyNewsItemRequest
PropertyData TypeNotes
NewsIDInt32

Output Properties

GetCompanyNewsItemResponse
PropertyData TypeNotes
DescriptionString
NewsIDInt32
CreatedDateDateTime
WebSettings NewsWebSettings
CompanySettings NewsCompanySettings
ContentString
DepartmentsDepartmentInfo[]
DepartmentInfo
PropertyData TypeNotes
DescriptionString
DepartmentType Int32Classification of a department as defined by the company.

Http Request

GET https://yourcompany-api.exigo.com/3.0/companynews/item?newsID=1
Authorization: Basic base64Encoded

Http Response

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


{
  "description": "",
  "newsID": 1,
  "createdDate": "2024-11-21T00:00:00-06:00",
  "webSettings": null,
  "companySettings": null,
  "content": "",
  "departments": null,
  "result": null
}

Soap Request

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

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetCompanyNewsItem"

<?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:Header>
    <ApiAuthentication xmlns="http://api.exigo.com/">
      <LoginName>string</LoginName>
      <Password>string</Password>
      <Company>string</Company>
      <Identity>string</Identity>
      <RequestTimeUtc>dateTime</RequestTimeUtc>
      <Signature>string</Signature>
    </ApiAuthentication>
  </soap:Header>
  <soap:Body>
    <GetCompanyNewsItemRequest xmlns="http://api.exigo.com/">
      <NewsID>int</NewsID>
    </GetCompanyNewsItemRequest>
  </soap:Body>
</soap:Envelope>

Soap Response

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>
    <GetCompanyNewsItemResult xmlns="http://api.exigo.com/">
      <Description>string</Description>
      <NewsID>int</NewsID>
      <CreatedDate>dateTime</CreatedDate>
      <WebSettings>AccessAvailable or AccessNotAvailable</WebSettings>
      <CompanySettings>AccessAllUsers or AccessByDepartment or AccessNotAvailable</CompanySettings>
      <Content>string</Content>
      <Departments>
        <DepartmentInfo>
          <Description>string</Description>
          <DepartmentType>int</DepartmentType>
        </DepartmentInfo>
      </Departments>
    </GetCompanyNewsItemResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new GetCompanyNewsItemRequest();

 

    req.NewsID = 1;

 

    //Send Request to Server and Get Response

    var res = await api.GetCompanyNewsItemAsync(req);

 

    //Now examine the results:

    Console.WriteLine("Description: {0}", res.Description);

    Console.WriteLine("NewsID: {0}", res.NewsID);

    Console.WriteLine("CreatedDate: {0}", res.CreatedDate);

    Console.WriteLine("WebSettings: {0}", res.WebSettings);

    Console.WriteLine("CompanySettings: {0}", res.CompanySettings);

    Console.WriteLine("Content: {0}", res.Content);

 

    foreach (var departmentInfo in res.Departments)

    {

        Console.WriteLine("Description: {0}", departmentInfo.Description);

        Console.WriteLine("DepartmentType: {0}", departmentInfo.DepartmentType);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

C# Soap Client

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetCompanyNewsItemRequest req = new GetCompanyNewsItemRequest();

 

    req.NewsID = 1;

 

    //Send Request to Server and Get Response

    GetCompanyNewsItemResponse res = api.GetCompanyNewsItem(req);

 

    //Now examine the results:

    Console.WriteLine("Description: {0}", res.Description);

    Console.WriteLine("NewsID: {0}", res.NewsID);

    Console.WriteLine("CreatedDate: {0}", res.CreatedDate);

    Console.WriteLine("WebSettings: {0}", res.WebSettings);

    Console.WriteLine("CompanySettings: {0}", res.CompanySettings);

    Console.WriteLine("Content: {0}", res.Content);

 

    foreach (DepartmentInfo departmentInfo in res.Departments)

    {

        Console.WriteLine("Description: {0}", departmentInfo.Description);

        Console.WriteLine("DepartmentType: {0}", departmentInfo.DepartmentType);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetCompanyNewsItemRequest()

 

    req.NewsID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetCompanyNewsItemResponse = api.GetCompanyNewsItem(req)

 

    'Now examine the results:

    Console.WriteLine("Description: {0}", res.Description)

    Console.WriteLine("NewsID: {0}", res.NewsID)

    Console.WriteLine("CreatedDate: {0}", res.CreatedDate)

    Console.WriteLine("WebSettings: {0}", res.WebSettings)

    Console.WriteLine("CompanySettings: {0}", res.CompanySettings)

    Console.WriteLine("Content: {0}", res.Content)

 

    For Each departmentInfo As DepartmentInfo In res.Departments

        Console.WriteLine("Description: {0}", departmentInfo.Description)

        Console.WriteLine("DepartmentType: {0}", departmentInfo.DepartmentType)

    Next

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->NewsID = 1;

 

    //Send Request to Server and Get Response

    $res = $api.GetCompanyNewsItem($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetCompanyNewsItemRequest req = new GetCompanyNewsItemRequest();

 

    req.setNewsID(1);

 

    //Send Request to Server and Get Response

    GetCompanyNewsItemResponse res = api.getExigoApiSoap().getCompanyNewsItem(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method supports CSV output.

HTTP Get Request:
https://totallife-api.exigo.com/3.0/csv/?method=GetCompanyNewsItem
&ApiLoginName=String
&ApiPassword=String
&ApiCompany=String
&NewsID=Int32

Response Fields
Description,NewsID,CreatedDate,WebSettings,CompanySettings,Content,Description,DepartmentType
String,Int32,DateTime,NewsWebSettings,NewsCompanySettings,String,String,Int32