POST api/Users

Adds a new user or updates information on an existing user.

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Username	User's username (Required).	string	None.
Password	User's password (Required).	string	None.
PasswordConfirmation	User's password (Required).	string	None.
Active	Indicates whether the user is active or not.	boolean	None.
Notes	User's notes.	string	None.
UpDoxId	User's up dox ID.	string	None.
Contact	User's contact information (Required).	ContactModel	None.
Locations	Locations to which the user has access.	Collection of string	None.
Id	Unique ID of the model in the portal (Read only).	globally unique identifier	None.
ExternalId	Unique ID of the model on integrating system (Required).	string	None.

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "password": "sample string 2",
  "passwordConfirmation": "sample string 3",
  "active": true,
  "notes": "sample string 5",
  "upDoxId": "sample string 6",
  "contact": {
    "id": "0d640ceb-d329-4273-9f7a-aa172121413e",
    "firstName": "sample string 2",
    "middleName": "sample string 3",
    "lastName": "sample string 4",
    "suffix": "sample string 5",
    "prefix": "sample string 6",
    "fullName": "sample string 7",
    "companyName": "sample string 8",
    "jobTitle": "sample string 9",
    "emailAddresses": [
      {
        "id": "cb2c8286-b219-426b-b6b5-da83d27ab531",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      },
      {
        "id": "cb2c8286-b219-426b-b6b5-da83d27ab531",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      }
    ],
    "phoneNumbers": [
      {
        "id": "240a4e1d-7d2e-4a1e-a354-f96081226487",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      },
      {
        "id": "240a4e1d-7d2e-4a1e-a354-f96081226487",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      }
    ],
    "postalAddresses": [
      {
        "id": "c6f70dcd-6546-4a32-93e7-b53657543204",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "7a2a9691-3825-4b89-abcf-1a6dc4516e86",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      },
      {
        "id": "c6f70dcd-6546-4a32-93e7-b53657543204",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "7a2a9691-3825-4b89-abcf-1a6dc4516e86",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      }
    ],
    "notes": "sample string 10"
  },
  "locations": [
    "sample string 1",
    "sample string 2"
  ],
  "id": "0102f8e7-9e42-44dc-b0b2-6bd742b009d9",
  "externalId": "sample string 8"
}

application/xml, text/xml

Sample:

<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Users">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 8</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">0102f8e7-9e42-44dc-b0b2-6bd742b009d9</Id>
  <Active>true</Active>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 8</d2p1:CompanyName>
    <d2p1:EmailAddresses>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>cb2c8286-b219-426b-b6b5-da83d27ab531</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>cb2c8286-b219-426b-b6b5-da83d27ab531</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:FullName>sample string 7</d2p1:FullName>
    <d2p1:Id>0d640ceb-d329-4273-9f7a-aa172121413e</d2p1:Id>
    <d2p1:JobTitle>sample string 9</d2p1:JobTitle>
    <d2p1:LastName>sample string 4</d2p1:LastName>
    <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
    <d2p1:Notes>sample string 10</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>240a4e1d-7d2e-4a1e-a354-f96081226487</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>240a4e1d-7d2e-4a1e-a354-f96081226487</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
    </d2p1:PhoneNumbers>
    <d2p1:PostalAddresses>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>7a2a9691-3825-4b89-abcf-1a6dc4516e86</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>c6f70dcd-6546-4a32-93e7-b53657543204</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>7a2a9691-3825-4b89-abcf-1a6dc4516e86</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>c6f70dcd-6546-4a32-93e7-b53657543204</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:Prefix>sample string 6</d2p1:Prefix>
    <d2p1:Suffix>sample string 5</d2p1:Suffix>
  </Contact>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Locations>
  <Notes>sample string 5</Notes>
  <Password>sample string 2</Password>
  <PasswordConfirmation>sample string 3</PasswordConfirmation>
  <UpDoxId>sample string 6</UpDoxId>
  <Username>sample string 1</Username>
</UserModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserModel'.

Resource Description

UserModel

Name	Description	Type	Additional information
Username	User's username (Required).	string	None.
Password	User's password (Required).	string	None.
PasswordConfirmation	User's password (Required).	string	None.
Active	Indicates whether the user is active or not.	boolean	None.
Notes	User's notes.	string	None.
UpDoxId	User's up dox ID.	string	None.
Contact	User's contact information (Required).	ContactModel	None.
Locations	Locations to which the user has access.	Collection of string	None.
Id	Unique ID of the model in the portal (Read only).	globally unique identifier	None.
ExternalId	Unique ID of the model on integrating system (Required).	string	None.

Response Formats

application/json, text/json

Sample:

{
  "username": "sample string 1",
  "password": "sample string 2",
  "passwordConfirmation": "sample string 3",
  "active": true,
  "notes": "sample string 5",
  "upDoxId": "sample string 6",
  "contact": {
    "id": "b226fd55-36b6-4ad6-b0ef-25fbd01fd6d2",
    "firstName": "sample string 2",
    "middleName": "sample string 3",
    "lastName": "sample string 4",
    "suffix": "sample string 5",
    "prefix": "sample string 6",
    "fullName": "sample string 7",
    "companyName": "sample string 8",
    "jobTitle": "sample string 9",
    "emailAddresses": [
      {
        "id": "f24ec0b3-13e2-48cf-8ef6-e813be00739b",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      },
      {
        "id": "f24ec0b3-13e2-48cf-8ef6-e813be00739b",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      }
    ],
    "phoneNumbers": [
      {
        "id": "768aec11-1de4-4498-9b21-52ba947f325a",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      },
      {
        "id": "768aec11-1de4-4498-9b21-52ba947f325a",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      }
    ],
    "postalAddresses": [
      {
        "id": "f9e9c818-8486-4767-b6ac-c813ef32d909",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "9c588ff3-fd20-4f61-b3e8-2e731ca82036",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      },
      {
        "id": "f9e9c818-8486-4767-b6ac-c813ef32d909",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "9c588ff3-fd20-4f61-b3e8-2e731ca82036",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      }
    ],
    "notes": "sample string 10"
  },
  "locations": [
    "sample string 1",
    "sample string 2"
  ],
  "id": "5e6dd693-99e9-4b63-b2e4-a3e2fee90caf",
  "externalId": "sample string 8"
}

application/xml, text/xml

Sample:

<UserModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Users">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 8</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">5e6dd693-99e9-4b63-b2e4-a3e2fee90caf</Id>
  <Active>true</Active>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 8</d2p1:CompanyName>
    <d2p1:EmailAddresses>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>f24ec0b3-13e2-48cf-8ef6-e813be00739b</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>f24ec0b3-13e2-48cf-8ef6-e813be00739b</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:FullName>sample string 7</d2p1:FullName>
    <d2p1:Id>b226fd55-36b6-4ad6-b0ef-25fbd01fd6d2</d2p1:Id>
    <d2p1:JobTitle>sample string 9</d2p1:JobTitle>
    <d2p1:LastName>sample string 4</d2p1:LastName>
    <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
    <d2p1:Notes>sample string 10</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>768aec11-1de4-4498-9b21-52ba947f325a</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>768aec11-1de4-4498-9b21-52ba947f325a</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
    </d2p1:PhoneNumbers>
    <d2p1:PostalAddresses>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>9c588ff3-fd20-4f61-b3e8-2e731ca82036</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>f9e9c818-8486-4767-b6ac-c813ef32d909</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>9c588ff3-fd20-4f61-b3e8-2e731ca82036</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>f9e9c818-8486-4767-b6ac-c813ef32d909</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:Prefix>sample string 6</d2p1:Prefix>
    <d2p1:Suffix>sample string 5</d2p1:Suffix>
  </Contact>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Locations>
  <Notes>sample string 5</Notes>
  <Password>sample string 2</Password>
  <PasswordConfirmation>sample string 3</PasswordConfirmation>
  <UpDoxId>sample string 6</UpDoxId>
  <Username>sample string 1</Username>
</UserModel>

Eye Reach Patients API Reference

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml