Cyan Web API - Version 1

GET api/messageBodies/login

            Gets an example of the message body format for a "Login" message.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "isExternal": true,
  "userName": "sample string 2",
  "password": "sample string 3",
  "userId": "688a50a2-f440-4e89-a73f-370c6b21220c",
  "userGroupId": "d22c331c-830a-4bdd-8477-f7e31d834a93",
  "tenantId": "204f39c0-4b6e-4f82-b0ff-d2d66e81e450",
  "tenantAccessKey": "sample string 4",
  "requestData": "sample string 5",
  "responseData": "sample string 6",
  "roles": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ]
}

application/xml, text/xml

Sample:

<LoginMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Messaging">
  <IsExternal>true</IsExternal>
  <Password>sample string 3</Password>
  <RequestData>sample string 5</RequestData>
  <ResponseData>sample string 6</ResponseData>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </Roles>
  <TenantAccessKey>sample string 4</TenantAccessKey>
  <TenantId>204f39c0-4b6e-4f82-b0ff-d2d66e81e450</TenantId>
  <UserGroupId>d22c331c-830a-4bdd-8477-f7e31d834a93</UserGroupId>
  <UserId>688a50a2-f440-4e89-a73f-370c6b21220c</UserId>
  <UserName>sample string 2</UserName>
</LoginMessageBody>