API12
Click here for a complete list of operations.
GetSiteRuleSet
Gets information about all TimeWorksPlus rules currently active for a site. Also contains the TimeWorksPlus status of the client. If the site doesn't have a rule set the ActiveRuleSetRevisionNumber property will be zero.
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 /pg/api12.asmx HTTP/1.1 Host: www.payrollservers.us Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://mc2cs.com/GetSiteRuleSet" <?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> <GetSiteRuleSet xmlns="http://mc2cs.com/"> <sessionid>string</sessionid> </GetSiteRuleSet> </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> <GetSiteRuleSetResponse xmlns="http://mc2cs.com/"> <GetSiteRuleSetResult> <ActiveRuleSet> <RuleDefinitions> <RuleDefinition xsi:nil="true" /> <RuleDefinition xsi:nil="true" /> </RuleDefinitions> </ActiveRuleSet> <ActiveRuleSetLastModifiedUTC>dateTime</ActiveRuleSetLastModifiedUTC> <ActiveRuleSetRevisionNumber>long</ActiveRuleSetRevisionNumber> <GlueStatus>string</GlueStatus> <SiteName>string</SiteName> <SiteNumber>int</SiteNumber> </GetSiteRuleSetResult> </GetSiteRuleSetResponse> </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 /pg/api12.asmx HTTP/1.1 Host: www.payrollservers.us 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> <GetSiteRuleSet xmlns="http://mc2cs.com/"> <sessionid>string</sessionid> </GetSiteRuleSet> </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> <GetSiteRuleSetResponse xmlns="http://mc2cs.com/"> <GetSiteRuleSetResult> <ActiveRuleSet> <RuleDefinitions> <RuleDefinition xsi:nil="true" /> <RuleDefinition xsi:nil="true" /> </RuleDefinitions> </ActiveRuleSet> <ActiveRuleSetLastModifiedUTC>dateTime</ActiveRuleSetLastModifiedUTC> <ActiveRuleSetRevisionNumber>long</ActiveRuleSetRevisionNumber> <GlueStatus>string</GlueStatus> <SiteName>string</SiteName> <SiteNumber>int</SiteNumber> </GetSiteRuleSetResult> </GetSiteRuleSetResponse> </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 /pg/api12.asmx/GetSiteRuleSet?sessionid=string HTTP/1.1 Host: www.payrollservers.us
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <GetSiteRuleSetApiResult xmlns="http://mc2cs.com/"> <ActiveRuleSet> <RuleDefinitions> <RuleDefinition ClassName="string" ClassRevision="int"> <Configuration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EmpSelectorConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EnableOnOrAfterDate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <XmlConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Description>string</Description> </RuleDefinition> <RuleDefinition ClassName="string" ClassRevision="int"> <Configuration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EmpSelectorConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EnableOnOrAfterDate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <XmlConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Description>string</Description> </RuleDefinition> </RuleDefinitions> </ActiveRuleSet> <ActiveRuleSetLastModifiedUTC>dateTime</ActiveRuleSetLastModifiedUTC> <ActiveRuleSetRevisionNumber>long</ActiveRuleSetRevisionNumber> <GlueStatus>string</GlueStatus> <SiteName>string</SiteName> <SiteNumber>int</SiteNumber> </GetSiteRuleSetApiResult>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /pg/api12.asmx/GetSiteRuleSet HTTP/1.1 Host: www.payrollservers.us Content-Type: application/x-www-form-urlencoded Content-Length: length sessionid=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <GetSiteRuleSetApiResult xmlns="http://mc2cs.com/"> <ActiveRuleSet> <RuleDefinitions> <RuleDefinition ClassName="string" ClassRevision="int"> <Configuration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EmpSelectorConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EnableOnOrAfterDate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <XmlConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Description>string</Description> </RuleDefinition> <RuleDefinition ClassName="string" ClassRevision="int"> <Configuration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EmpSelectorConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <EnableOnOrAfterDate d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <XmlConfiguration d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Description>string</Description> </RuleDefinition> </RuleDefinitions> </ActiveRuleSet> <ActiveRuleSetLastModifiedUTC>dateTime</ActiveRuleSetLastModifiedUTC> <ActiveRuleSetRevisionNumber>long</ActiveRuleSetRevisionNumber> <GlueStatus>string</GlueStatus> <SiteName>string</SiteName> <SiteNumber>int</SiteNumber> </GetSiteRuleSetApiResult>