Welcome
Guest
, you are in:
<root>
EnterpriseLibrary
FDOT Security STS
FDOT_Application_Model
GisFramework
•
Login
FDOT Wiki
Navigation (EnterpriseLibrary)
¶
Enterprise Library
FDOT Wiki
Random Page
All Pages
Categories
Search the wiki
»
Back
StaffService_v4
Modified on Wednesday, 06 November 2013 03:32 PM
by 156.75.200.109
Categorized as
Uncategorized
Interface for the Staff Service. {toc} ==GetAllStaffTypeCodes== Returns a list of the staff type codes as IStaffTypeCode. ====Signature==== @@IEnumerable<IStaffTypeCode> GetAllStaffTypeCodes();@@ ====net.tcp example==== (((@@var result = ChannelProvider<IStaffService>.Default.GetAllStaffTypeCodes();@@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/typecodes/] ==GetNewStaffSearchCriteria== Returns an empty IStaffSearchCriteria. ====Signature==== @@IStaffSearchCriteria GetNewStaffSearchCriteria();@@ ====net.tcp Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetNewStaffSearchCriteria();@@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/search/] ==GetStaffById== Returns an IStaffMember by id. ====Signature==== @@IStaffMember GetStaffById(int staffId);@@ ====net.tcp example==== (((@@var result = ChannelProvider<IStaffService>.Default.GetStaffById(23802); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/23802/] ==GetStaffByIds== Returns a list of IStaffMember by id. ====Signature==== @@IEnumerable<IStaffMember> GetStaffByIds(IEnumerable<int> staffIds);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetStaffByIds(new[] {1,2,3,4,5}); @@))) ====REST example==== Accessible via JavaScript, but not RESTful. ==GetStaffByRacfId== Returns an IStaffMember by RACF id. ====Signature==== @@IStaffMember GetStaffByRacfId(string racfId);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetStaffByRacfId("knatcss"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/racf/knatcss/] ==GetStaffByRacfIds== Returns a list of IStaffMember by RACF id. ====Signature==== @@IEnumerable<IStaffMember> GetStaffByRacfIds(IEnumerable<string> racfIds);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetStaffByRacfIds(new[] {"id1", "id2", "id3"}); @@))) ====REST example==== Accessible via JavaScript, but not RESTful. ==GetStaffByPeopleFirstId== Returns an IStaffMember by PeopleFirst id. ====Signature==== @@IStaffMember GetStaffByPeopleFirstId(string peopleFirstId);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetStaffByPeopleFirstId("peopleFirstId"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/peoplefirst/peopleFirstId/] ==SearchStaffBySearchCriteria== Returns a list of IStaffMember matching IStaffSearchCriteria. ====Signature==== @@IEnumerable<IStaffMember> SearchStaffBySearchCriteria(IStaffSearchCriteria staffSearchCriteria);@@ ====Code Sample==== (((@@var criteria = proxy.GetNewStaffSearchCriteria(); criteria.IncludeActive = true; criteria.OrganizationalCode = new OrgCodeId("55053010559"); var results = proxy.SearchStaffBySearchCriteria(criteria); @@))) ====REST example==== Format: http://dotscofelhostu/fel4_u/StaffService.svc/staff/bycriteria?criteria={staffSearchCriteria} [http://dotscofelhostu/fel4_u/StaffService.svc/staff/bycriteria?criteria={IncludeActive:true,OrganizationalCode:{FullOrgCode:55053010559}}] ==GetAllStaff== Returns a list of IStaffMember containing ALL staff. ====Signature==== @@IEnumerable<IStaffMember> GetAllStaff();@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetAllStaff(); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/] ==GetStaffByAdGroup== Returns a list of IStaffMember active and in the specified Active Directory group. ====Signature==== @@IEnumerable<IStaffMember> GetStaffByAdGroup(string group);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetStaffByAdGroup("bssowebstandards"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/group/bssowebstandards/] ==GetInactiveStaffByInactivatedDate== Returns a list of IStaffMember inactive as of the specified date. ====Signature==== @@IEnumerable<IStaffMember> GetInactiveStaffByInactivatedDate(DateTime inactivatedDate);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetInactiveStaffByInactivatedDate(DateTime.Now.AddMonths(-1)); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/inactive/2013-10-01/] ==GetActiveStaffByPosition== Returns a list of IStaffMember active and in the specified position. ====Signature==== @@IEnumerable<IStaffMember> GetActiveStaffByPosition(string position);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetActiveStaffByPosition(); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/position/014285/active/] ==SearchStaffByName== Returns a list of IStaffMember by partial name. ====Signature==== @@IEnumerable<IStaffMember> SearchStaffByName(string partialName);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.SearchStaffByName("test"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/name/partial/test/] ==SearchStaffByFirstAndOrLastName== Returns a list of IStaffMember by first and/or last name. ====Signature==== @@IEnumerable<IStaffMember> SearchStaffByFirstAndOrLastName(string firstName, string lastName);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.SearchStaffByFirstAndOrLastName("test", "account"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/name/test/account/] ==GetAllStaffByDistrict== Returns a list of IStaffMember within the specified district. ====Signature==== @@IEnumerable<IStaffMember> GetAllStaffByDistrict(string districtCode); IEnumerable<IStaffMember> GetAllStaffByDistrict(string districtCode, bool includeInactive); IEnumerable<IStaffMember> GetActiveStaffByDistrict(string districtCode);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetAllStaffByDistrict("08"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/district/08/] [http://dotscofelhostu/fel4_u/StaffService.svc/staff/district/08/active/] ==GetDelegatesForStaffMember== Returns a list of IStaffMember who are delegates for the specified staff member. ====Signature==== @@IEnumerable<IStaffDelegate> GetDelegatesForStaffMember(int staffId, string application); IEnumerable<IStaffDelegate> GetDelegatesForStaffMember(string staffId, string application); IEnumerable<IStaffDelegate> GetDelegatesForStaffMember(IStaffMember staff, string application);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetDelegatesForStaffMember(4, "myapp"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/4/delegates/myapp/] ==GetWhoStaffIsDelegateFor== Returns a list of IStaffMember who the specified staff member is a delegate for within the specified application. ====Signature==== @@IEnumerable<IStaffDelegate> GetWhoStaffIsDelegateFor(int staffId, string application); IEnumerable<IStaffDelegate> GetWhoStaffIsDelegateFor(string staffId, string application); IEnumerable<IStaffDelegate> GetWhoStaffIsDelegateFor(IStaffMember staff, string application);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetWhoStaffIsDelegateFor(4, "myapp"); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/4/delegator/myapp/] ==SetDelegate== Sets a delegate within the specified application. ====Signature==== @@void SetDelegate(int delegatorId, int delegateeId, string application); void SetDelegate(string delegatorId, string delegateeId, string application); void SetDelegate(IStaffMember delegator, IStaffMember delegatee, string application);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.SetDelegate(4, 8, "myapp"); @@))) ====REST example==== PUT [http://dotscofelhostu/fel4_u/StaffService.svc/staff/4/8/myapp/] ==RemoveDelegate== Removes a delegate within the specified application. ====Signature==== @@void RemoveDelegate(int delegatorId, int delegateeId, string application); void RemoveDelegate(string delegatorId, string delegateeId, string application); void RemoveDelegate(IStaffDelegate staffDelegate);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.RemoveDelegate(4, 8, "myapp"); @@))) ====REST example==== DELETE [http://dotscofelhostu/fel4_u/StaffService.svc/staff/4/8/myapp/] ==UpdateSignature== Updates the signature for the specified staff member. ====Signature==== @@void UpdateSignature(int staffId, string newSignature); void UpdateSignature(string staffId, string newSignature);@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.SetDelegate(4, "This is a test signature."); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/4/signature/This is a test signature./] ==GetVersion== Returns the current service version. ====Signature==== @@string GetVersion();@@ ====Code Sample==== (((@@var result = ChannelProvider<IStaffService>.Default.GetVersion(); @@))) ====REST example==== [http://dotscofelhostu/fel4_u/StaffService.svc/staff/version/] ==See Also== {incoming}
Meta Keywords:
Meta Description:
Change Comment:
ScrewTurn Wiki
version 3.0.4.560. Some of the icons created by
FamFamFam
.