Relative request path: | api/orgs/{organisationId}/purpose-codes/code({code}) |
Property | Description |
---|---|
organisationId | |
code | Purposecode code |
Request parameters:
Request parameters:
Request parameters:
Property | Description |
---|---|
PurposeCodeId | Purpose code id Mandatory. |
Code | Code. Optional. Max length: 4. |
Description | Purpose code description. Optional. Max length: 250. |
This method returns result of type 'SAOP.API.Models.PurposeCode.PurposeCode'.
/// Purpose code details
public class PurposeCode
{
// Purpose code id
// Mandatory field. Ignored on create request.
public long PurposeCodeId { get; set; }
// Code.
// Max length: 4
public string Code { get; set; }
// Purpose code description.
// Max length: 250
public string Description { get; set; }
}
This method returns result of type 'SAOP.API.Models.PurposeCode.PurposeCode'.
/// Purpose code details
class PurposeCode
{
// Purpose code id
// Mandatory field. Ignored on create request.
public $PurposeCodeId;
// Code.
// Max length: 4
public $Code;
// Purpose code description.
// Max length: 250
public $Description;
}
This method returns result of type 'SAOP.API.Models.PurposeCode.PurposeCode'.
/// Purpose code details
public class PurposeCode
{
// Purpose code id
// Mandatory field. Ignored on create request.
public Long PurposeCodeId;
// Code.
// Max length: 4
public String Code;
// Purpose code description.
// Max length: 250
public String Description;
}