GET api/invitations/{id}

Check if invitation code is valid, by GET to /api/invitations/{invitationcode}. If code is valid, returns 200 OK and an extended resource containing invitation Id and associated user record. If code does not exist, returns 404 Not Found. If code exists but is not valid, returns 409 Conflict, and the reason phrase gives more details

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

InvitationRepresentation

Name	Description	Type	Additional information
Id	Unique identifier of this invitation - same as in CRM	globally unique identifier	None.
User	Embedded user resource - the user that received this invitation	UserRepresentation	None.
Links		Collection of Link	None.

Response Formats

application/json

Sample:

{
  "Id": "ac293df1-7741-4485-8bf8-1c6d534d8d59",
  "User": {
    "Id": "4f99dd13-4118-45fd-a2d1-ff0b81913ad0",
    "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": "47e4b388-cf51-4b99-8d3e-b07176545eeb",
    "StatusValue": 9,
    "StatusLabel": "sample string 10",
    "JobTitle": "sample string 11",
    "JobRole": "dbc1e36b-d5ee-42c7-8272-f2b761e66d14",
    "InvitationCode": "eacbd471-0c4c-4305-b8ce-3fedcc4fad2c",
    "XrmContactId": "55655a46-1495-491a-a84a-606447664a70",
    "_links": [
      {
        "Rel": "self",
        "Href": "~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0",
        "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/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles",
        "Title": null,
        "IsTemplated": false
      },
      {
        "Rel": "subjects",
        "Href": "~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects",
        "Title": null,
        "IsTemplated": false
      }
    ],
    "_embedded": null
  },
  "_links": [
    {
      "Rel": "self",
      "Href": "~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59",
      "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
    }
  ],
  "_embedded": null
}

text/json

Sample:

{
  "Id": "ac293df1-7741-4485-8bf8-1c6d534d8d59",
  "User": {
    "Id": "4f99dd13-4118-45fd-a2d1-ff0b81913ad0",
    "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": "47e4b388-cf51-4b99-8d3e-b07176545eeb",
    "StatusValue": 9,
    "StatusLabel": "sample string 10",
    "JobTitle": "sample string 11",
    "JobRole": "dbc1e36b-d5ee-42c7-8272-f2b761e66d14",
    "InvitationCode": "eacbd471-0c4c-4305-b8ce-3fedcc4fad2c",
    "XrmContactId": "55655a46-1495-491a-a84a-606447664a70",
    "_links": [
      {
        "Rel": "self",
        "Href": "~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0",
        "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/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles",
        "Title": null,
        "IsTemplated": false
      },
      {
        "Rel": "subjects",
        "Href": "~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects",
        "Title": null,
        "IsTemplated": false
      },
      {
        "Rel": "roles",
        "Href": "~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles",
        "Title": null,
        "IsTemplated": false
      },
      {
        "Rel": "subjects",
        "Href": "~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects",
        "Title": null,
        "IsTemplated": false
      }
    ],
    "_embedded": null
  },
  "_links": [
    {
      "Rel": "self",
      "Href": "~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59",
      "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
    }
  ],
  "_embedded": null
}

application/xml

Sample:

<InvitationRepresentation 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">~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 4</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59</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>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 2</Rel>
  <Id>ac293df1-7741-4485-8bf8-1c6d534d8d59</Id>
  <User>
    <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0</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/4f99dd13-4118-45fd-a2d1-ff0b81913ad0</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/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects</Href>
        <Rel>subjects</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects</Href>
        <Rel>subjects</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/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>4f99dd13-4118-45fd-a2d1-ff0b81913ad0</Id>
    <IdSource>3</IdSource>
    <InvitationCode>eacbd471-0c4c-4305-b8ce-3fedcc4fad2c</InvitationCode>
    <JobRole>dbc1e36b-d5ee-42c7-8272-f2b761e66d14</JobRole>
    <JobTitle>sample string 11</JobTitle>
    <LastName>sample string 5</LastName>
    <LocalLogin>sample string 2</LocalLogin>
    <OrgId>47e4b388-cf51-4b99-8d3e-b07176545eeb</OrgId>
    <OrgMemberNumber>sample string 8</OrgMemberNumber>
    <StatusLabel>sample string 10</StatusLabel>
    <StatusValue>9</StatusValue>
    <Telephone>sample string 7</Telephone>
    <XrmContactId>55655a46-1495-491a-a84a-606447664a70</XrmContactId>
  </User>
</InvitationRepresentation>

text/xml

Sample:

<InvitationRepresentation 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">~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59</Href>
  <LinkName xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 4</LinkName>
  <Links xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">
    <Link>
      <Href>~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59</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>
  </Links>
  <Rel xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">sample string 2</Rel>
  <Id>ac293df1-7741-4485-8bf8-1c6d534d8d59</Id>
  <User>
    <Href xmlns="http://schemas.datacontract.org/2004/07/WebApi.Hal">~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0</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/4f99dd13-4118-45fd-a2d1-ff0b81913ad0</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/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects</Href>
        <Rel>subjects</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects</Href>
        <Rel>subjects</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects</Href>
        <Rel>subjects</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles</Href>
        <Rel>roles</Rel>
        <Title i:nil="true" />
      </Link>
      <Link>
        <Href>~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/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>4f99dd13-4118-45fd-a2d1-ff0b81913ad0</Id>
    <IdSource>3</IdSource>
    <InvitationCode>eacbd471-0c4c-4305-b8ce-3fedcc4fad2c</InvitationCode>
    <JobRole>dbc1e36b-d5ee-42c7-8272-f2b761e66d14</JobRole>
    <JobTitle>sample string 11</JobTitle>
    <LastName>sample string 5</LastName>
    <LocalLogin>sample string 2</LocalLogin>
    <OrgId>47e4b388-cf51-4b99-8d3e-b07176545eeb</OrgId>
    <OrgMemberNumber>sample string 8</OrgMemberNumber>
    <StatusLabel>sample string 10</StatusLabel>
    <StatusValue>9</StatusValue>
    <Telephone>sample string 7</Telephone>
    <XrmContactId>55655a46-1495-491a-a84a-606447664a70</XrmContactId>
  </User>
</InvitationRepresentation>

application/hal+json

Sample:

{
  "Id": "ac293df1-7741-4485-8bf8-1c6d534d8d59",
  "_links": {
    "self": {
      "href": "/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3"
    }
  },
  "_embedded": {
    "sample string 13": {
      "Id": "4f99dd13-4118-45fd-a2d1-ff0b81913ad0",
      "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": "47e4b388-cf51-4b99-8d3e-b07176545eeb",
      "StatusValue": 9,
      "StatusLabel": "sample string 10",
      "JobTitle": "sample string 11",
      "JobRole": "dbc1e36b-d5ee-42c7-8272-f2b761e66d14",
      "InvitationCode": "eacbd471-0c4c-4305-b8ce-3fedcc4fad2c",
      "XrmContactId": "55655a46-1495-491a-a84a-606447664a70",
      "_links": {
        "self": {
          "href": "/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0"
        },
        "sample string 1": {
          "href": "sample string 2",
          "title": "sample string 3"
        },
        "roles": {
          "href": "/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles"
        },
        "subjects": {
          "href": "/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects"
        }
      }
    }
  }
}

application/hal+xml

Sample:

<resource rel="sample string 2" href="~/invitations/ac293df1-7741-4485-8bf8-1c6d534d8d59" name="sample string 4">
  <link rel="sample string 1" href="sample string 2" />
  <Id>ac293df1-7741-4485-8bf8-1c6d534d8d59</Id>
  <resource rel="sample string 13" href="~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0" name="sample string 15">
    <link rel="sample string 1" href="sample string 2" />
    <link rel="roles" href="~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/roles" />
    <link rel="subjects" href="~/users/4f99dd13-4118-45fd-a2d1-ff0b81913ad0/subjects" />
    <Id>4f99dd13-4118-45fd-a2d1-ff0b81913ad0</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>47e4b388-cf51-4b99-8d3e-b07176545eeb</OrgId>
    <StatusValue>9</StatusValue>
    <StatusLabel>sample string 10</StatusLabel>
    <JobTitle>sample string 11</JobTitle>
    <JobRole>dbc1e36b-d5ee-42c7-8272-f2b761e66d14</JobRole>
    <InvitationCode>eacbd471-0c4c-4305-b8ce-3fedcc4fad2c</InvitationCode>
    <XrmContactId>55655a46-1495-491a-a84a-606447664a70</XrmContactId>
  </resource>
</resource>