Relative request path: | api/orgs/{organisationId}/customers/{customerId}/contacts/{contactId} |
Property | Description |
---|---|
organisationId | organisation id |
customerId | customer id |
contactId | contact id |
Request parameters:
Request parameters:
Request parameters:
Property | Description |
---|---|
ContactId | Contact id. Mandatory. |
Customer | class Customer. Customer. Mandatory. |
FullName | First and last name. Mandatory. Max length: 100. |
PhoneNumber | Telephone number. Optional. Max length: 30. |
Fax | Fax. Optional. Max length: 30. |
MobilePhone | Mobile phone. Optional. Max length: 30. |
E-mail. Optional. Max length: 50. | |
Notes | Notes. Optional. Max length: 50. |
Default | Default contact:
|
RecordDtModified | Optional. |
RowVersion | Row version is used for concurrency check. |
This method returns result of type 'SAOP.API.Models.Contact.Contact'.
/// Contact details.
public class Contact
{
// Contact id.
// Mandatory field. Ignored on create request.
public long ContactId { get; set; }
// Customer.
public mMApiFkField Customer { get; set; }
// First and last name.
// Mandatory field. Max length: 100
public string FullName { get; set; }
// Telephone number.
// Max length: 30
public string PhoneNumber { get; set; }
// Fax.
// Max length: 30
public string Fax { get; set; }
// Mobile phone.
// Max length: 30
public string MobilePhone { get; set; }
// E-mail.
// Max length: 50
public string Email { get; set; }
// Notes.
// Max length: 50
public string Notes { get; set; }
// Default contact:
// <ul>
//     <li>D – Yes,</li>
//     <li>N – No.</li>
// </ul>
//
// Max length: 1
public string Default { get; set; }
public DateTime RecordDtModified { get; set; }
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public string RowVersion { get; set; }
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public long? ID { get; set; }
// Record name.
public string Name { get; private set; }
// Url to full record details.
public string ResourceUrl { get; private set; }
}
This method returns result of type 'SAOP.API.Models.Contact.Contact'.
/// Contact details.
class Contact
{
// Contact id.
// Mandatory field. Ignored on create request.
public $ContactId;
// Customer.
public $Customer;
// First and last name.
// Mandatory field. Max length: 100
public $FullName;
// Telephone number.
// Max length: 30
public $PhoneNumber;
// Fax.
// Max length: 30
public $Fax;
// Mobile phone.
// Max length: 30
public $MobilePhone;
// E-mail.
// Max length: 50
public $Email;
// Notes.
// Max length: 50
public $Notes;
// Default contact:
// <ul>
//     <li>D – Yes,</li>
//     <li>N – No.</li>
// </ul>
//
// Max length: 1
public $Default;
public $RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public $RowVersion;
}
/// Link with id, name and url to related data.
class mMApiFkField
{
// Record id.
public $ID;
// Record name.
public $Name;
// Url to full record details.
public $ResourceUrl;
}
This method returns result of type 'SAOP.API.Models.Contact.Contact'.
/// Contact details.
public class Contact
{
// Contact id.
// Mandatory field. Ignored on create request.
public Long ContactId;
// Customer.
public mMApiFkField Customer;
// First and last name.
// Mandatory field. Max length: 100
public String FullName;
// Telephone number.
// Max length: 30
public String PhoneNumber;
// Fax.
// Max length: 30
public String Fax;
// Mobile phone.
// Max length: 30
public String MobilePhone;
// E-mail.
// Max length: 50
public String Email;
// Notes.
// Max length: 50
public String Notes;
// Default contact:
// <ul>
//     <li>D – Yes,</li>
//     <li>N – No.</li>
// </ul>
//
// Max length: 1
public String Default;
public Date RecordDtModified;
// Row version is used for concurrency check.
// Mandatory field. Ignored on create request.
public String RowVersion;
}
/// Link with id, name and url to related data.
public class mMApiFkField
{
// Record id.
public Long ID;
// Record name.
public String Name;
// Url to full record details.
public String ResourceUrl;
}