GET api/users?xrmContactId={xrmContactId}

Get user details by XrmContactId - used if we do not have user Id

Request Information

URI Parameters

Name	Description	Type	Additional information
xrmContactId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

UserRepresentation

Name	Description	Type	Additional information
Id	Unique identifier - same as in CRM	globally unique identifier	None.
LocalLogin	Login for this system	string	None.
IdSource	The source of identity for this user. Defined values are: 0 = reserved for test suites; 1 = SSAT website	integer	None.
FirstName	First name	string	None.
LastName	last name	string	None.
Email	Email address	string	None.
Telephone	Main telephone number	string	None.
OrgMemberNumber	Organisation membership number	string	None.
OrgId	Organisation ID	globally unique identifier	None.
StatusValue	User status	integer	None.
StatusLabel	User status label	string	None.
JobTitle	Free text job title	string	None.
JobRole	Reference to job role from pre-set list	globally unique identifier	None.
InvitationCode	Most recent invitation code generated by CRM	globally unique identifier	None.
XrmContactId	Unique XRM Id for the associated contact (NB N:1 User:Contact)	globally unique identifier	None.
Links		Collection of Link	None.

Response Formats

application/json

Sample:

{
  "Id": "03e02578-824c-4fe3-aa1c-aa670e69c245",
  "LocalLogin": "sample string 2",
  "IdSource": 3,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "Telephone": "sample string 7",
  "OrgMemberNumber": "sample string 8",
  "OrgId": "324bad50-956b-497e-8485-c76e008a79c7",
  "StatusValue": 9,
  "StatusLabel": "sample string 10",
  "JobTitle": "sample string 11",
  "JobRole": "fd4a3463-45d1-4b2c-843f-53901a3dae58",
  "InvitationCode": "9d4ec539-e6c6-4640-8804-2b7f93c0b904",
  "XrmContactId": "7b718d78-9d56-4d8f-8e1a-a427ad61c142",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "roles",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "subjects",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects",
      "Title": null,
      "IsTemplated": false
    }
  ],
  "_embedded": null
}

text/json

Sample:

{
  "Id": "03e02578-824c-4fe3-aa1c-aa670e69c245",
  "LocalLogin": "sample string 2",
  "IdSource": 3,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "Telephone": "sample string 7",
  "OrgMemberNumber": "sample string 8",
  "OrgId": "324bad50-956b-497e-8485-c76e008a79c7",
  "StatusValue": 9,
  "StatusLabel": "sample string 10",
  "JobTitle": "sample string 11",
  "JobRole": "fd4a3463-45d1-4b2c-843f-53901a3dae58",
  "InvitationCode": "9d4ec539-e6c6-4640-8804-2b7f93c0b904",
  "XrmContactId": "7b718d78-9d56-4d8f-8e1a-a427ad61c142",
  "_links": [
    {
      "Rel": "self",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "IsTemplated": false
    },
    {
      "Rel": "roles",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "subjects",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "roles",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles",
      "Title": null,
      "IsTemplated": false
    },
    {
      "Rel": "subjects",
      "Href": "~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects",
      "Title": null,
      "IsTemplated": false
    }
  ],
  "_embedded": null
}

application/xml

Sample:

<UserRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.WebServices.WebApp.Representations.Version1">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/users/03e02578-824c-4fe3-aa1c-aa670e69c245</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 15</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245</Href>
      <Rel>self</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 13</Rel>
  <Email>sample string 6</Email>
  <FirstName>sample string 4</FirstName>
  <Id>03e02578-824c-4fe3-aa1c-aa670e69c245</Id>
  <IdSource>3</IdSource>
  <InvitationCode>9d4ec539-e6c6-4640-8804-2b7f93c0b904</InvitationCode>
  <JobRole>fd4a3463-45d1-4b2c-843f-53901a3dae58</JobRole>
  <JobTitle>sample string 11</JobTitle>
  <LastName>sample string 5</LastName>
  <LocalLogin>sample string 2</LocalLogin>
  <OrgId>324bad50-956b-497e-8485-c76e008a79c7</OrgId>
  <OrgMemberNumber>sample string 8</OrgMemberNumber>
  <StatusLabel>sample string 10</StatusLabel>
  <StatusValue>9</StatusValue>
  <Telephone>sample string 7</Telephone>
  <XrmContactId>7b718d78-9d56-4d8f-8e1a-a427ad61c142</XrmContactId>
</UserRepresentation>

text/xml

Sample:

<UserRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSAT.WebServices.WebApp.Representations.Version1">
  <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/users/03e02578-824c-4fe3-aa1c-aa670e69c245</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 15</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245</Href>
      <Rel>self</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles</Href>
      <Rel>roles</Rel>
      <Title i:nil="true" />
    </Link>
    <Link>
      <Href>~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects</Href>
      <Rel>subjects</Rel>
      <Title i:nil="true" />
    </Link>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 13</Rel>
  <Email>sample string 6</Email>
  <FirstName>sample string 4</FirstName>
  <Id>03e02578-824c-4fe3-aa1c-aa670e69c245</Id>
  <IdSource>3</IdSource>
  <InvitationCode>9d4ec539-e6c6-4640-8804-2b7f93c0b904</InvitationCode>
  <JobRole>fd4a3463-45d1-4b2c-843f-53901a3dae58</JobRole>
  <JobTitle>sample string 11</JobTitle>
  <LastName>sample string 5</LastName>
  <LocalLogin>sample string 2</LocalLogin>
  <OrgId>324bad50-956b-497e-8485-c76e008a79c7</OrgId>
  <OrgMemberNumber>sample string 8</OrgMemberNumber>
  <StatusLabel>sample string 10</StatusLabel>
  <StatusValue>9</StatusValue>
  <Telephone>sample string 7</Telephone>
  <XrmContactId>7b718d78-9d56-4d8f-8e1a-a427ad61c142</XrmContactId>
</UserRepresentation>

application/hal+json

Sample:

{
  "Id": "03e02578-824c-4fe3-aa1c-aa670e69c245",
  "LocalLogin": "sample string 2",
  "IdSource": 3,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Email": "sample string 6",
  "Telephone": "sample string 7",
  "OrgMemberNumber": "sample string 8",
  "OrgId": "324bad50-956b-497e-8485-c76e008a79c7",
  "StatusValue": 9,
  "StatusLabel": "sample string 10",
  "JobTitle": "sample string 11",
  "JobRole": "fd4a3463-45d1-4b2c-843f-53901a3dae58",
  "InvitationCode": "9d4ec539-e6c6-4640-8804-2b7f93c0b904",
  "XrmContactId": "7b718d78-9d56-4d8f-8e1a-a427ad61c142",
  "_links": {
    "self": {
      "href": "/users/03e02578-824c-4fe3-aa1c-aa670e69c245"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    },
    "roles": {
      "href": "/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles"
    },
    "subjects": {
      "href": "/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects"
    }
  }
}

application/hal+xml

Sample:

<resource rel="sample string 13" href="~/users/03e02578-824c-4fe3-aa1c-aa670e69c245" name="sample string 15">
  <link rel="sample string 1" href="sample string 2" />
  <link rel="roles" href="~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/roles" />
  <link rel="subjects" href="~/users/03e02578-824c-4fe3-aa1c-aa670e69c245/subjects" />
  <Id>03e02578-824c-4fe3-aa1c-aa670e69c245</Id>
  <LocalLogin>sample string 2</LocalLogin>
  <IdSource>3</IdSource>
  <FirstName>sample string 4</FirstName>
  <LastName>sample string 5</LastName>
  <Email>sample string 6</Email>
  <Telephone>sample string 7</Telephone>
  <OrgMemberNumber>sample string 8</OrgMemberNumber>
  <OrgId>324bad50-956b-497e-8485-c76e008a79c7</OrgId>
  <StatusValue>9</StatusValue>
  <StatusLabel>sample string 10</StatusLabel>
  <JobTitle>sample string 11</JobTitle>
  <JobRole>fd4a3463-45d1-4b2c-843f-53901a3dae58</JobRole>
  <InvitationCode>9d4ec539-e6c6-4640-8804-2b7f93c0b904</InvitationCode>
  <XrmContactId>7b718d78-9d56-4d8f-8e1a-a427ad61c142</XrmContactId>
</resource>