GET api/user/{aAbrev}/{aLocId}/{aLocationServiceID}

Get All Users From Careplanner for loc_id and cps_area

Request Information

URI Parameters

Name	Description	Type	Additional information
aAbrev	Abreviated Organisation Name	string	Required
aLocId	timecard location id	integer	Required
aLocationServiceID		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of UserModel

Name	Type	Additional information
UserID	integer	None.
EmailAddress	string	None.
Password	string	None.
LastLogon	date	None.
FailureSinceSuccess	integer	None.
LastFailureDate	date	None.
PwdChangeDate	date	None.
OrganisationID	integer	None.
GroupTypeID	integer	None.
ClientCode	string	None.
PersonForename	string	None.
PersonSurname	string	None.
TitleDescription	string	None.
PreferredName	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
AddressLine3	string	None.
AddressLine4	string	None.
AddressPostcode	string	None.
AddressPostcodeFirstPart	string	None.
AddressPostcodeSecondPart	string	None.
TelephoneNumber	string	None.
MobileNumber	string	None.
DateOfBirth	date	None.
LocationServiceID	integer	None.
UserCreated	string	None.
DateCreated	date	None.
UserUpdated	string	None.
DateUpdated	date	None.
UserArchived	string	None.
DateArchived	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserID": 1,
    "EmailAddress": "sample string 2",
    "Password": "sample string 3",
    "LastLogon": "2026-01-15T12:51:00.9546764+00:00",
    "FailureSinceSuccess": 5,
    "LastFailureDate": "2026-01-15T12:51:00.9546764+00:00",
    "PwdChangeDate": "2026-01-15T12:51:00.9546764+00:00",
    "OrganisationID": 8,
    "GroupTypeID": 9,
    "ClientCode": "sample string 10",
    "PersonForename": "sample string 11",
    "PersonSurname": "sample string 12",
    "TitleDescription": "sample string 13",
    "PreferredName": "sample string 14",
    "AddressLine1": "sample string 15",
    "AddressLine2": "sample string 16",
    "AddressLine3": "sample string 17",
    "AddressLine4": "sample string 18",
    "AddressPostcode": "sample string 19 sample string 20",
    "AddressPostcodeFirstPart": "sample string 19",
    "AddressPostcodeSecondPart": "sample string 20",
    "TelephoneNumber": "sample string 21",
    "MobileNumber": "sample string 22",
    "DateOfBirth": "2026-01-15T12:51:00.9546764+00:00",
    "LocationServiceID": 1,
    "UserCreated": "sample string 24",
    "DateCreated": "2026-01-15T12:51:00.9546764+00:00",
    "UserUpdated": "sample string 26",
    "DateUpdated": "2026-01-15T12:51:00.9546764+00:00",
    "UserArchived": "sample string 28",
    "DateArchived": "2026-01-15T12:51:00.9546764+00:00"
  },
  {
    "UserID": 1,
    "EmailAddress": "sample string 2",
    "Password": "sample string 3",
    "LastLogon": "2026-01-15T12:51:00.9546764+00:00",
    "FailureSinceSuccess": 5,
    "LastFailureDate": "2026-01-15T12:51:00.9546764+00:00",
    "PwdChangeDate": "2026-01-15T12:51:00.9546764+00:00",
    "OrganisationID": 8,
    "GroupTypeID": 9,
    "ClientCode": "sample string 10",
    "PersonForename": "sample string 11",
    "PersonSurname": "sample string 12",
    "TitleDescription": "sample string 13",
    "PreferredName": "sample string 14",
    "AddressLine1": "sample string 15",
    "AddressLine2": "sample string 16",
    "AddressLine3": "sample string 17",
    "AddressLine4": "sample string 18",
    "AddressPostcode": "sample string 19 sample string 20",
    "AddressPostcodeFirstPart": "sample string 19",
    "AddressPostcodeSecondPart": "sample string 20",
    "TelephoneNumber": "sample string 21",
    "MobileNumber": "sample string 22",
    "DateOfBirth": "2026-01-15T12:51:00.9546764+00:00",
    "LocationServiceID": 1,
    "UserCreated": "sample string 24",
    "DateCreated": "2026-01-15T12:51:00.9546764+00:00",
    "UserUpdated": "sample string 26",
    "DateUpdated": "2026-01-15T12:51:00.9546764+00:00",
    "UserArchived": "sample string 28",
    "DateArchived": "2026-01-15T12:51:00.9546764+00:00"
  }
]

text/html

Sample:

[{"UserID":1,"EmailAddress":"sample string 2","Password":"sample string 3","LastLogon":"2026-01-15T12:51:00.9546764+00:00","FailureSinceSuccess":5,"LastFailureDate":"2026-01-15T12:51:00.9546764+00:00","PwdChangeDate":"2026-01-15T12:51:00.9546764+00:00","OrganisationID":8,"GroupTypeID":9,"ClientCode":"sample string 10","PersonForename":"sample string 11","PersonSurname":"sample string 12","TitleDescription":"sample string 13","PreferredName":"sample string 14","AddressLine1":"sample string 15","AddressLine2":"sample string 16","AddressLine3":"sample string 17","AddressLine4":"sample string 18","AddressPostcode":"sample string 19 sample string 20","AddressPostcodeFirstPart":"sample string 19","AddressPostcodeSecondPart":"sample string 20","TelephoneNumber":"sample string 21","MobileNumber":"sample string 22","DateOfBirth":"2026-01-15T12:51:00.9546764+00:00","LocationServiceID":1,"UserCreated":"sample string 24","DateCreated":"2026-01-15T12:51:00.9546764+00:00","UserUpdated":"sample string 26","DateUpdated":"2026-01-15T12:51:00.9546764+00:00","UserArchived":"sample string 28","DateArchived":"2026-01-15T12:51:00.9546764+00:00"},{"UserID":1,"EmailAddress":"sample string 2","Password":"sample string 3","LastLogon":"2026-01-15T12:51:00.9546764+00:00","FailureSinceSuccess":5,"LastFailureDate":"2026-01-15T12:51:00.9546764+00:00","PwdChangeDate":"2026-01-15T12:51:00.9546764+00:00","OrganisationID":8,"GroupTypeID":9,"ClientCode":"sample string 10","PersonForename":"sample string 11","PersonSurname":"sample string 12","TitleDescription":"sample string 13","PreferredName":"sample string 14","AddressLine1":"sample string 15","AddressLine2":"sample string 16","AddressLine3":"sample string 17","AddressLine4":"sample string 18","AddressPostcode":"sample string 19 sample string 20","AddressPostcodeFirstPart":"sample string 19","AddressPostcodeSecondPart":"sample string 20","TelephoneNumber":"sample string 21","MobileNumber":"sample string 22","DateOfBirth":"2026-01-15T12:51:00.9546764+00:00","LocationServiceID":1,"UserCreated":"sample string 24","DateCreated":"2026-01-15T12:51:00.9546764+00:00","UserUpdated":"sample string 26","DateUpdated":"2026-01-15T12:51:00.9546764+00:00","UserArchived":"sample string 28","DateArchived":"2026-01-15T12:51:00.9546764+00:00"}]

application/xml, text/xml

Sample:

<ArrayOfUserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels">
  <UserModel>
    <DateArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:51:00.9546764+00:00</DateArchived>
    <DateCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:51:00.9546764+00:00</DateCreated>
    <DateUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:51:00.9546764+00:00</DateUpdated>
    <UserArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 28</UserArchived>
    <UserCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 24</UserCreated>
    <UserUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 26</UserUpdated>
    <AddressLine1>sample string 15</AddressLine1>
    <AddressLine2>sample string 16</AddressLine2>
    <AddressLine3>sample string 17</AddressLine3>
    <AddressLine4>sample string 18</AddressLine4>
    <AddressPostcodeFirstPart>sample string 19</AddressPostcodeFirstPart>
    <AddressPostcodeSecondPart>sample string 20</AddressPostcodeSecondPart>
    <ClientCode>sample string 10</ClientCode>
    <DateOfBirth>2026-01-15T12:51:00.9546764+00:00</DateOfBirth>
    <EmailAddress>sample string 2</EmailAddress>
    <FailureSinceSuccess>5</FailureSinceSuccess>
    <GroupTypeID>9</GroupTypeID>
    <LastFailureDate>2026-01-15T12:51:00.9546764+00:00</LastFailureDate>
    <LastLogon>2026-01-15T12:51:00.9546764+00:00</LastLogon>
    <LocationServiceID>1</LocationServiceID>
    <MobileNumber>sample string 22</MobileNumber>
    <OrganisationID>8</OrganisationID>
    <Password>sample string 3</Password>
    <PersonForename>sample string 11</PersonForename>
    <PersonSurname>sample string 12</PersonSurname>
    <PreferredName>sample string 14</PreferredName>
    <PwdChangeDate>2026-01-15T12:51:00.9546764+00:00</PwdChangeDate>
    <TelephoneNumber>sample string 21</TelephoneNumber>
    <TitleDescription>sample string 13</TitleDescription>
    <UserID>1</UserID>
  </UserModel>
  <UserModel>
    <DateArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:51:00.9546764+00:00</DateArchived>
    <DateCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:51:00.9546764+00:00</DateCreated>
    <DateUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">2026-01-15T12:51:00.9546764+00:00</DateUpdated>
    <UserArchived xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 28</UserArchived>
    <UserCreated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 24</UserCreated>
    <UserUpdated xmlns="http://schemas.datacontract.org/2004/07/CPS.Api.Domain.DomainModels.Base">sample string 26</UserUpdated>
    <AddressLine1>sample string 15</AddressLine1>
    <AddressLine2>sample string 16</AddressLine2>
    <AddressLine3>sample string 17</AddressLine3>
    <AddressLine4>sample string 18</AddressLine4>
    <AddressPostcodeFirstPart>sample string 19</AddressPostcodeFirstPart>
    <AddressPostcodeSecondPart>sample string 20</AddressPostcodeSecondPart>
    <ClientCode>sample string 10</ClientCode>
    <DateOfBirth>2026-01-15T12:51:00.9546764+00:00</DateOfBirth>
    <EmailAddress>sample string 2</EmailAddress>
    <FailureSinceSuccess>5</FailureSinceSuccess>
    <GroupTypeID>9</GroupTypeID>
    <LastFailureDate>2026-01-15T12:51:00.9546764+00:00</LastFailureDate>
    <LastLogon>2026-01-15T12:51:00.9546764+00:00</LastLogon>
    <LocationServiceID>1</LocationServiceID>
    <MobileNumber>sample string 22</MobileNumber>
    <OrganisationID>8</OrganisationID>
    <Password>sample string 3</Password>
    <PersonForename>sample string 11</PersonForename>
    <PersonSurname>sample string 12</PersonSurname>
    <PreferredName>sample string 14</PreferredName>
    <PwdChangeDate>2026-01-15T12:51:00.9546764+00:00</PwdChangeDate>
    <TelephoneNumber>sample string 21</TelephoneNumber>
    <TitleDescription>sample string 13</TitleDescription>
    <UserID>1</UserID>
  </UserModel>
</ArrayOfUserModel>